Project Provider protocol. More...
#import <KFXProjectProviderProtocol.h>
Inheritance diagram for <KFXProjectProviderProtocol>:
Instance Methods | |
| (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... | |
| (NSString *) | - getLatestCachedModelDataInfo |
| Get latest cached model data build information. More... | |
Detailed Description
Project Provider protocol.
Specifies the protocol required to satisfy extraction dependencies.
Method Documentation
| - (void) getHighestVersion: | (NSString *) | sdkVersion | |
| completionHandler: | (void(^)(NSString *version, NSError *error)) | completionHandler | |
Get latest data version.
Get the highest version string that is compatible with the given SDK version.
- Parameters
-
sdkVersion - SDK version. completionHandler - callback will be fired on completion. If nil no work will be done. - version: latest data version. May be nil in case of an error.
- error: contains an error if there is one.
| - (void) getHighestVersion: | (NSString *) | projectName | |
| sdkVersion: | (NSString *) | sdkVersion | |
| completionHandler: | (void(^)(NSString *version, NSError *error)) | DEPRECATED_ATTRIBUTE | |
Get latest data version.
Get the highest version string that is compatible with the given SDK version.
- Parameters
-
projectName - The name of the project. This parameter is no longer used and will be ignored. sdkVersion - SDK version. completionHandler - callback will be fired on completion. If nil no work will be done. - version: latest data version. May be nil in case of an error.
- error: contains an error if there is one.
- Deprecated:
- Deprecated in SDK 3.5. Replaced by getHighestVersion:completionHandler:
| - (NSString*) getLatestCachedModelDataInfo |
Get latest cached model data build information.
Use this method to get the latest cached model data build information.
- Returns
- cached model data build information for project. Will be nil if model data build inforation was not found.
| - (NSString*) getLatestCachedModelDataInfo: | (NSString *) | DEPRECATED_ATTRIBUTE |
Get latest cached model data build information.
Use this method to get the latest cached model data build information.
- Parameters
-
projectName - The name of the project. This parameter is no longer used and will be ignored.
- Returns
- cached model data build information for project. Will be nil if model data build inforation was not found.
- Deprecated:
- Deprecated in SDK 3.5. Replaced by getLatestCachedModelDataInfo
Reimplemented in KFXServerProjectProvider, and KFXLocalBundleProjectProvider.
| - (void) getProject: | (NSString *) | version | |
| completionHandler: | (void(^)(NSString *path, NSError *error)) | completionHandler | |
Get project data.
Get path to the project data for the given version.
- Parameters
-
version - version. completionHandler - callback will be fired on completion. If nil no work will be done. - path: path to project data. May be nil in case of an error.
- error: contains an error if there is one.
| - (void) getProject: | (NSString *) | projectName | |
| version: | (NSString *) | version | |
| completionHandler: | (void(^)(NSString *path, NSError *error)) | DEPRECATED_ATTRIBUTE | |
Get project data.
Get path to the project data for the given version.
- Parameters
-
projectName - The name of the project. This parameter is no longer used and will be ignored. version - version. completionHandler - callback will be fired on completion. If nil no work will be done. - path: path to project data. May be nil in case of an error.
- error: contains an error if there is one.
- Deprecated:
- Deprecated in SDK 3.5. Replaced by getProject:completionHandler:
| - (void) getVariant: | (NSString *) | variant | |
| forProject: | (NSString *) | projectName | |
| version: | (NSString *) | version | |
| completionHandler: | (void(^)(NSString *path, NSError *error)) | DEPRECATED_ATTRIBUTE | |
Get variant data.
Get path to the variant data for the given version.
- Parameters
-
variant - variant name. projectName - The name of the project. This parameter is no longer used and will be ignored. version - version. completionHandler - callback will be fired on completion. If nil no work will be done. - path: path to variant data. May be nil in case of an error.
- error: contains an error if there is one.
- Deprecated:
- Deprecated in SDK 3.5. Replaced by getVariant:version:completionHandler:
| - (void) getVariant: | (NSString *) | variant | |
| version: | (NSString *) | version | |
| completionHandler: | (void(^)(NSString *path, NSError *error)) | completionHandler | |
Get variant data.
Get path to the variant data for the given version.
- Parameters
-
variant - variant name. version - version. completionHandler - callback will be fired on completion. If nil no work will be done. - path: path to variant data. May be nil in case of an error.
- error: contains an error if there is one.
The documentation for this protocol was generated from the following file: