Kofax Mobile SDK API Reference
Public Member Functions | List of all members
IProjectProvider Interface Reference
Inheritance diagram for IProjectProvider:
LocalProjectProvider ServerProjectProvider

Public Member Functions

void getHighestVersion (final String projectName, final String sdkVersion, final ICompletionListener< String > listener)
 
void getHighestVersion (final String sdkVersion, final ICompletionListener< String > listener)
 
void getProject (final String projectName, final String version, final ICompletionListener< File > listener)
 
void getProject (final String version, final ICompletionListener< File > listener)
 
void getVariant (final String projectName, final String variantName, final String version, final ICompletionListener< File > listener)
 
void getVariant (final String variantName, final String version, final ICompletionListener< File > listener)
 
String getLatestCachedModelDataBuildInfo (String projectName)
 
String getLatestCachedModelDataBuildInfo ()
 

Detailed Description

Specifies the interface required to satisfy extraction dependencies

Member Function Documentation

void getHighestVersion ( final String  projectName,
final String  sdkVersion,
final ICompletionListener< String >  listener 
)

Get the highest version string that is compatible with the given SDK version

Note: The listener's object parameter will be null, or a string representing the highest compatible version

Parameters
projectNameThe name of the project. This parameter is no longer used and will be ignored.
sdkVersionThe version of the SDK that must be compatible
listenerA completion listener. If this is null, no work will be done.
Deprecated:
Deprecated in SDK 3.5. Replaced by IProjectProvider#getHighestVersion(String, ICompletionListener<String>).

Implemented in ServerProjectProvider, and LocalProjectProvider.

void getHighestVersion ( final String  sdkVersion,
final ICompletionListener< String >  listener 
)

Get the highest version string that is compatible with the given SDK version

Note: The listener's object parameter will be null, or a string representing the highest compatible version

Parameters
sdkVersionThe version of the SDK that must be compatible
listenerA completion listener. If this is null, no work will be done.
String getLatestCachedModelDataBuildInfo ( String  projectName)

Get the latest model data build information from cached project

Parameters
projectNameThe name of the project. This parameter is no longer used and will be ignored.
Returns
The latest model data build info if available, otherwise a null string
Deprecated:
Deprecated in SDK 3.5. Replaced by IProjectProvider#getLatestCachedModelDataBuildInfo().

Implemented in ServerProjectProvider, and LocalProjectProvider.

String getLatestCachedModelDataBuildInfo ( )

Get the latest model data build information from cached project

Returns
The latest model data build info if available, otherwise a null string

Implemented in ServerProjectProvider, and LocalProjectProvider.

void getProject ( final String  projectName,
final String  version,
final ICompletionListener< File >  listener 
)

Get the project bundle for the given version

Note: The listener's object parameter will be a ZIP containing the top-level project files, including the fields.xml, classifier configurations, and cities.zip, and a file listing the available variants

Parameters
projectNameThe name of the project. This parameter is no longer used and will be ignored.
versionThe version of the project
listenerA completion listener. If this is null, no work will be done.
Deprecated:
Deprecated in SDK 3.5. Replaced by IProjectProvider#getProject(String, ICompletionListener<File>).

Implemented in ServerProjectProvider, and LocalProjectProvider.

void getProject ( final String  version,
final ICompletionListener< File >  listener 
)

Get the project bundle for the given version

Note: The listener's object parameter will be a ZIP containing the top-level project files, including the fields.xml, classifier configurations, and cities.zip, and a file listing the available variants

Parameters
versionThe version of the project
listenerA completion listener. If this is null, no work will be done.
void getVariant ( final String  projectName,
final String  variantName,
final String  version,
final ICompletionListener< File >  listener 
)

Get a variant for the given version

Note: The listener's object parameter will be a ZIP containing the variant-specific files

Parameters
projectNameThe name of the project. This parameter is no longer used and will be ignored.
variantNameThe name of the variant
versionThe version of the variant (this should match the same version string retrieved from getHighestVersion(String, String, ICompletionListener)
listenerA completion listener. If this is null, no work will be done.
Deprecated:
Deprecated in SDK 3.5. Replaced by IProjectProvider#getVariant(String, String, CompletionListener<File>).

Implemented in ServerProjectProvider, and LocalProjectProvider.

void getVariant ( final String  variantName,
final String  version,
final ICompletionListener< File >  listener 
)

Get a variant for the given version

Note: The listener's object parameter will be a ZIP containing the variant-specific files

Parameters
variantNameThe name of the variant
versionThe version of the variant (this should match the same version string retrieved from getHighestVersion(String, String, ICompletionListener)
listenerA completion listener. If this is null, no work will be done.

The documentation for this interface was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.