signoAPI iOS – STLicenceStatus class | signotec Knowledge Base

The STLicenceStatus class is a data object that contains status information for the licence currently used. For further information, see also -[STLicenceManager getLicenceStatus:]. The class is part of libSignoPDFSigner as well as of libSignoSignatureCapture. The individual properties of the STLicenceStatus / the status information are described in the following table.

Property

Description

@property(nonatomic,assign, readonly) LicenceType licenceType

Property	Description
LicenceType licenceType	-
Return value	Description
-	-

Licensing status.

@property(nonatomic,strong, readonly) NSDate* licenceDate

Property	Description
NSDate* licenceDate	-
Return value	Description
-	-

Expiry date of the licence.

@property(nonatomic,assign, readonly) AmsType amsType

Property	Description
AmsType amsType	-
Return value	Description
-	-

Status of the software maintenance contract.

@property(nonatomic,strong, readonly) NSDate* amsDate

Property	Description
NSDate* amsDate	-
Return value	Description
-	-

Expiry date of the software maintenance contract.

@property(nonatomic,assign, readonly) OfflineType offlineType

Property	Description
OfflineType offlineType	-
Return value	Description
-	-

Status of the offline licensing.

@property(nonatomic,strong, readonly) NSDate* offlineDate

Property	Description
NSDate* offlineDate	-
Return value	Description
-	-

Expiry date of the offline licensing.

@property(nonatomic,strong, readonly) NSDate* timeStampDate

Property	Description
NSDate* timeStampDate	-
Return value	Description
-	-

Time when the licence was last updated online.

@property(nonatomic,assign, readonly) BOOL activationReminder

Property	Description
BOOL activationReminder	-
Return value	Description
-	-

Information as to whether the user should be asked to update the licence online.

YES

The user should be asked to update the licence online.

The user should not be asked to update the licence online.

@property(nonatomic,strong, readonly) NSDate* activationReminderDate

Property	Description
NSDate* activationReminderDate	-
Return value	Description
-	-

Time when the user should be asked to update the licence online.

@property(nonatomic,strong, readonly) NSString* customerName

Property	Description
NSString* customerName	-
Return value	Description
-	-

Name of the company for which the licence was issued.

@property(nonatomic,strong, readonly) NSString* customerNumber

Property	Description
NSString* customerNumber	-
Return value	Description
-	-

Customer number of the company for which the licence was issued.

@property(nonatomic,strong, readonly) NSString* resellerName

Property	Description
NSString* resellerName	-
Return value	Description
-	-

Vendor that created the licence.

@property(nonatomic,strong, readonly) NSDate* purchasedDateOn

Property	Description
NSDate* purchasedDateOn	-
Return value	Description
-	-

Date when the licence was issued.

@property(nonatomic, assign, readonly) NSInteger activations

Property	Description
NSInteger activations	-
Return value	Description
-	-

Current number of licence activations.

@property(nonatomic, assign, readonly) NSInteger maxActivations

Property	Description
NSInteger maxActivations	-
Return value	Description
-	-

Maximum number of licence activations.

@property(nonatomic,strong, readonly) NSMutableArray* features

Property	Description
NSMutableArray* features	-
Return value	Description
-	-

List of licensed features.

@property(nonatomic,strong, readonly) NSString* activationId

Property	Description
NSString* activationId	-
Return value	Description
-	-

Activation ID.

@property(nonatomic,strong, readonly) NSString* productId

Property	Description
NSString* productId	-
Return value	Description
-	-

ID of the product for which the licence was issued.

@property(nonatomic,strong, readonly) STLicenceResult* licenceResult

Property	Description
STLicenceResult* licenceResult	-
Return value	Description
-	-

Instance of the STLicenceResult class. See the licence error table in the STLicenceError class.

The LicenceType enumeration is defined as follows:

typedef enum licenceType { Unknown_Licence,

Demo_Licence,

Unlimited_Licence,

Limited_Licence

} LicenceType;

Value	Description
Unknown_Licence	Unknown licensing status.
Demo_Licence	API is not licensed and is running in demo mode.
Unlimited_Licence	API is licensed for an unlimited time period.
Limited_Licence	API is only licensed until a certain expiry date.

The AmsType enumeration is defined as follows:

typedef enum amsType { Unknown,

Unavailable,

Available,

Limited

} AmsType;

Value	Description
Unknown	Unknown status of the software maintenance contract.
Unavailable	No software maintenance contract is available.
Available	A software maintenance contract without time limitation is available.
Limited	A software maintenance contract is only available up until a certain expiry date.

The OfflineType enumeration is defined as follows:

typedef enum offlineType { Unknown_Offline_Use,

Limited_Offline_Use,

Unlimited_Offline_Use

} OfflineType;

Value	Description
Unknown_Offline_Use	Unknown status of offline licensing.
Limited_Offline_Use	API can only be used offline up until the expiry date.
Unlimited_Offline_Use	API can be used offline for an unlimited time period.