kfxLicense Class Reference

License for unlocking library features. More...

#import <kfxLicense.h>

Inheritance diagram for kfxLicense:

Instance Methods
(void)	- setMobileSDKLicenseServer:
	Set up the SDK license server. More...
(void)	- acquireOnDeviceExtractionLicensesWithCount:
	Preallocate volume licenses for offline operation. More...
(int)	- getRemainingOnDeviceExtractionLicenseCount
	Get remaining license count. More...

Class Methods
(BOOL)	+ setMobileSDKLicense:
	Sets the SDK usage license. More...

Properties
id< kfxAcquireVolumeLicenseDelegate >	delegate
	License delegate. More...
id< kfxCustomAcquireVolumeLicenseDelegate >	customAcquireVolumeLicenseDelegate
	The custom acquire licenses delegate. More...

Detailed Description

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 the license, other library API methods work as designed. The license remains valid while the app is still running.

You use the setMobileSDKLicense method on the kfxLicense object to set the license.

Method Documentation

- (void) acquireOnDeviceExtractionLicensesWithCount:

(int)

count

Preallocate volume licenses for offline operation.

The function is used to preallocate volume licenses for on-device extraction operation. Outstanding license usage will be reported to the server when server connection is available.

Parameters

count

Number of volume license requested. Example code follows showing how to preallocate volume licenses for offlince operation.

self.myLicense = [[kfxLicense alloc] init]; // create the licensing object
self.myLicense.delegate = self; // set the delegate
[self.myLicense setMobileSDKLicenseServer:@"http://licenseserver.example.com"]; // set the license server
[self.myLicense acquireOnDeviceExtractionLicensesWithCount:20]; //preallocate 20 volume licenses

- (int) getRemainingOnDeviceExtractionLicenseCount

Get remaining license count.

The function will return available license count for the offline operation, application should

Returns

this method returns count of volume license acquired.

Example code follows showing how to get remaining license count.

self.myLicense = [[kfxLicense alloc] init]; // create the licensing object
self.myLicense.delegate = self; // set the delegate
[self.myLicense setMobileSDKLicenseServer:@"http://licenseserver.example.com"]; // set the license server
[self.myLicense acquireOnDeviceExtractionLicensesWithCount:20]; //preallocate 20 volume licenses
NSLog(@"Remain licenses %d", [self getRemainingOnDeviceExtractionLicenseCount]);

+ (BOOL) setMobileSDKLicense:

(NSString *)

license

Sets the SDK usage license.

The input to this method is the VRS license string.

Parameters

license

is the valid license string that was contained in a distributed header file that you received with the purchase of the SDK.

Returns

returns YES if license valid and days remain in the license and NO otherwise

- (void) setMobileSDKLicenseServer:

(NSString *)

licenseServerUrl

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. Outstanding license usage will be reported to the server when server connection is available.

Parameters

licenseServerUrl

should be a valid url string of the on device operation licensing server. Example code follows showing how to set your license server.

self.myLicense = [[kfxLicense alloc] init]; // create the licensing object
self.myLicense.delegate = self; // set the delegate
[self.myLicense setMobileSDKLicenseServer:@"http://licenseserver.example.com"]; // set the license server

Property Documentation

- (id<kfxCustomAcquireVolumeLicenseDelegate>) customAcquireVolumeLicenseDelegate

readwritenonatomicweak

The custom acquire licenses delegate.

Set the delegate to receive custom request data that would have request and the response handlers. Users must send the response back to the completion handler

- (id<kfxAcquireVolumeLicenseDelegate>) delegate

readwritenonatomicweak

License delegate.

Set the delegate to receive licesnse callbacks.

---

The documentation for this class was generated from the following file:

• kfxLicense.h