Atalasoft MobileImage API Reference
Instance Methods | List of all members
<KFXBundleCacheProviderProtocol> Protocol Reference

Bundle Cache Provider protocol. More...

#import <KFXBundleCacheProviderProtocol.h>

Inheritance diagram for <KFXBundleCacheProviderProtocol>:
KFXBundleCacheProvider

Instance Methods

(NSString *) - getProjectWithName:version:
 Get project path. More...
 
(NSString *) - cacheProjectWithName:bundle:version:error:
 Cache project. More...
 
(NSString *) - getVariantWithName:forProject:version:
 Get variant path. More...
 
(NSString *) - cacheVariantWithName:forProject:bundle:version:error:
 Cache project. More...
 
(NSString *) - latestVersionForProject:
 Get latest cached version. More...
 

Detailed Description

Bundle Cache Provider protocol.

This protocol defines the methods that should be implemented by cache provider.

Method Documentation

- (NSString*) cacheProjectWithName: (NSString *)  projectName
bundle: (id< KFXBundleProtocol >)  bundle
version: (NSString *)  version
error: (NSError **)  error 

Cache project.

Use this method to cache project data.

Parameters
projectName- project name.
bundle- bundle object which generalize file container.
version- project data version.
error- error object instance which will contain error info if cache failed.
Returns
path to folder containing cached project files. Will be nil in default implementations if cache failed.
- (NSString*) cacheVariantWithName: (NSString *)  variantName
forProject: (NSString *)  projectName
bundle: (id< KFXBundleProtocol >)  bundle
version: (NSString *)  version
error: (NSError **)  error 

Cache project.

Use this method to cache variant data.

Parameters
variantName- variant name.
projectName- variant project name.
bundle- bundle object which generalize file container.
version- variant data version.
error- error object instance which will contain error info if cache failed.
Returns
path to folder containing cached variant files. Will be nil in default implementations if cache failed.
- (NSString*) getProjectWithName: (NSString *)  projectName
version: (NSString *)  version 

Get project path.

Use this method to get the path to specified project files.

Parameters
projectName- project name.
version- project data version.
Returns
path to folder containing cached project files. Will be nil in default implementations if cached data for specified project and version was not found.
- (NSString*) getVariantWithName: (NSString *)  variantName
forProject: (NSString *)  projectName
version: (NSString *)  version 

Get variant path.

Use this method to get the path to specified variant files.

Parameters
variantName- variant name.
projectName- variant project name.
version- variant data version.
Returns
path to folder containing cached variant files. Will be nil in default implementations if cached data for specified variant, project and version was not found.
- (NSString*) latestVersionForProject: (NSString *)  projectName

Get latest cached version.

Use this method to get the latest cached version for the given project.

Parameters
projectName- project name.
Returns
latest version for project. Will be nil if project data was not found.

The documentation for this protocol was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.