Kofax Mobile SDK API Reference
|
License for unlocking library features. More...
#import <kfxKUTLicensing.h>
Instance Methods | |
(int) | - setMobileSDKLicense: |
Sets the SDK usage license. More... | |
(void) | - setMobileSDKLicenseServer:type: |
Set up the SDK license server. More... | |
(void) | - acquireVolumeLicenses:withCount: |
Preallocate volume licenses for offline operation. More... | |
(int) | - getRemainingLicenseCount: |
Get remaining license count. More... | |
Class Methods | |
(int) | + isSdkLicensed: |
Checks if the SDK has been licensed for a specific feature. More... | |
Properties | |
id< kfxKUTAcquireVolumeLicenseDelegate > | delegate |
id< kfxKUTCustomAcquireVolumeLicenseDelegate > | customAcquireVolumeLicenseDelegate |
The custom acquire licenses delegate. More... | |
id< kfxKUTCertificateValidatorDelegate > | certificateValidatorDelegate |
The certificate validator delegate. More... | |
int | daysRemaining |
Indicates the number of days before the license expires. More... | |
License for unlocking library features.
An instance of this class contains the properties and methods you must use to set the usage license. Once you set your usage license, you can use included properties to determine the license end date. Once you set the license, other library API methods work as designed. The license remains valid while the app is still running.
Classes that contain licensed methods will include a description that highlights that it is a license protected class. Certain methods in that object are protected by this license mechanism. If you attempt to use the instance methods without setting the license, then you will receive the KMC_IP_LICENSE_INVALID error code in most cases. Refer to the method descriptions within the class to determine what methods are license protected. You use the setMobileSDKLicense method on the kfxKUTLicensing object to set the license.
Examples of licensed classes include kfxKEDImage and kfxKENImageProcessor.
- (void) acquireVolumeLicenses: | (kfxKUTLicenseFeature) | licenseType | |
withCount: | (int) | count | |
Preallocate volume licenses for offline operation.
The function is used to preallocate volume licenses for offline operation.
licenseType | Volume license type. |
count | Number of volume license requested. Example code follows showing how to preallocate volume licenses for offlince operation. |
- (int) getRemainingLicenseCount: | (kfxKUTLicenseFeature) | licType |
Get remaining license count.
The function will return available license count for the offline operation
licType | Volume license type to check. |
+ (int) isSdkLicensed: | (kfxKUTLicenseFeature) | feature |
Checks if the SDK has been licensed for a specific feature.
Some license keys may only unlock a subset of features within the SDK. This method is for checking whether a particular feature is available after a license has been successfully applied. If a valid license hasn't been set, this method will return KMC_EV_LICENSING for all features. If a license has been set that is not feature-restricted, this method will return KMC_SUCCESS for all features.
feature | The feature being tested. |
- (int) setMobileSDKLicense: | (NSString *) | license |
Sets the SDK usage license.
The input to this method is the VRS license string. If the license string is valid and days remain in the license, this method returns KMC_SUCCESS, and sets the daysRemaining property to the number of days remaining in the license. If the license string is valid but no days remain in the license, this method returns KMC_IP_LICENSE_EXPIRED. If the license string is not valid, this method returns KMC_IP_LICENSE_INVALID. Any failure to set the license sets the daysRemaining property to zero.
license | is the valid license string that was contained in a distributed header file that you received from Kofax. |
- (void) setMobileSDKLicenseServer: | (NSString *) | licenseServerUrl | |
type: | (kfxKUTLicenseServerType) | serverType | |
Set up the SDK license server.
The function is used to setup the url string of license server used for on device operation licensing. Application must call this function before any on device operation that requires license.
licenseServerUrl | should be a valid url string of the on device operation licensing server. |
serverType | should be one of the server type from the kfxKUTLicenseServerType enum. Example code follows showing how to set your license server. |
|
readwritenonatomicweak |
The certificate validator delegate.
The delegate receives certificate validation challenge in response to an authentication request from the remote server.
|
readwritenonatomicweak |
The custom acquire licenses delegate.
The delegate receives the request from SDK and would have the compeltion handler that user should call for sending the response back. For adding your own custom server to fetch licenses, the user must set this delegate. And while setting this licenseServerUrl in the below api call is optional and serverType is mandatory -(void)setMobileSDKLicenseServer: (NSString*) licenseServerUrl type:(kfxKUTLicenseServerType) serverType
|
readatomicassign |
Indicates the number of days before the license expires.
After you set the license, this field indicates how many days are left in your license. The library initializes this value to 0.
|
readwritenonatomicweak |