Kofax Mobile SDK API Reference
Instance Methods | List of all members
KFXLocalBundleProjectProvider Class Reference

Local Bundle Project Provider. More...

#import <KFXLocalBundleProjectProvider.h>

Inheritance diagram for KFXLocalBundleProjectProvider:
<KFXProjectProviderProtocol>

Instance Methods

(instancetype) - initWithCacheProvider:
 Constructor. More...
 
(instancetype) - initWithPath:
 Constructor. More...
 
(instancetype) - initWithPath:cacheProvider:
 Constructor. More...
 
(NSString *) - getLatestCachedModelDataInfo:
 Get latest cached model data build information. More...
 
- Instance Methods inherited from <KFXProjectProviderProtocol>
(void) - getHighestVersion:sdkVersion:completionHandler:
 Get latest data version. More...
 
(void) - getHighestVersion:completionHandler:
 Get latest data version. More...
 
(void) - getProject:version:completionHandler:
 Get project data. More...
 
(void) - getProject:completionHandler:
 Get project data. More...
 
(void) - getVariant:forProject:version:completionHandler:
 Get variant data. More...
 
(void) - getVariant:version:completionHandler:
 Get variant data. More...
 
(NSString *) - getLatestCachedModelDataInfo
 Get latest cached model data build information. More...
 

Detailed Description

Local Bundle Project Provider.

This implementation of KFXProjectProviderProtocol allows to get assets from zip bundles stored in application resources. By default it uses KFXBundleCacheProvider instance with default cache directory and main bundle root location for bundles.

Project zip bundles are expected to be named as project_name%.zip (e.g. USIDs.zip).

See also
KFXProjectProviderProtocol
KFXBundleCacheProvider

Method Documentation

- (NSString*) getLatestCachedModelDataInfo: (NSString *)  projectName

Get latest cached model data build information.

Use this method to get the latest cached model data build information for the given project.

Parameters
projectName- project name.
Returns
cached model data build information for project. Will be nil if model data build inforation was not found.

Reimplemented from <KFXProjectProviderProtocol>.

- (instancetype) initWithCacheProvider: (id< KFXBundleCacheProviderProtocol >)  cacheProvider

Constructor.

Initializes the object with a custom cache provider instance.

Parameters
cacheProvider- custom cache provider instance. If nil, nil object will be returned.
See also
KFXBundleCacheProviderProtocol
- (instancetype) initWithPath: (NSString *)  path

Constructor.

Initializes the object with a custom path to folder containing project zip bundles.

Parameters
path- path to folder. If nil, nil object will be returned.
- (instancetype) initWithPath: (NSString *)  path
cacheProvider: (id< KFXBundleCacheProviderProtocol >)  cacheProvider 

Constructor.

Initializes the object with custom path to folder containing project zip bundles and cache provider instance.

Parameters
path- path to folder. If nil, nil object will be returned.
cacheProvider- custom cache provider instance. If nil, nil object will be returned.
See also
KFXBundleCacheProviderProtocol

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