Helper class for serializing and deserializing the LicenseDescriptor JSON. More...
#include <ConfigurationObjects.h>
Inherits AppConfigurationObjects::ConfigurationObjectBase.
Public Member Functions | |
| void | clear () |
 Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| virtual void | initForDocumenting () |
| virtual std::string | toString () |
| virtual bool | isDocumenting () const |
Public Attributes | |
| std::string | entitlement |
| Entitlement key to use for the product. | |
| std::string | key |
| License Key to be used for the application. | |
| std::string | activationCode |
| If the key required activation, this is the activation code generated using the entitlement, key and deviceId. | |
| std::string | deviceId |
| [Read only] Unique device identifier generated by the Engine. | |
| int | type |
| [Read only] 0 = unknown, 1 = perpetual, 2 = expires | |
| time_t | expires |
| [Read only] The time that the license key or activation code expires in Unix timestamp - Zulu/UTC. | |
| std::string | expiresFormatted |
| [Read only] The time that the license key or activation code expires formatted in ISO 8601 format, Zulu/UTC. | |
| uint32_t | flags |
| Reserved. | |
| std::string | cargo |
| Reserved for internal use. | |
| uint8_t | cargoFlags |
| Reserved for internal use. | |
| int | status |
| The current licensing status. | |
| std::string | manufacturerId |
| [Read only] Manufacturer ID. | |
| Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| nlohmann::json | _attached |
Static Public Attributes | |
| static const int | STATUS_OK = 0 |
| static const int | ERR_NULL_ENTITLEMENT_KEY = -1 |
| static const int | ERR_NULL_LICENSE_KEY = -2 |
| static const int | ERR_INVALID_LICENSE_KEY_LEN = -3 |
| static const int | ERR_LICENSE_KEY_VERIFICATION_FAILURE = -4 |
| static const int | ERR_ACTIVATION_CODE_VERIFICATION_FAILURE = -5 |
| static const int | ERR_INVALID_EXPIRATION_DATE = -6 |
| static const int | ERR_GENERAL_FAILURE = -7 |
| static const int | ERR_NOT_INITIALIZED = -8 |
| static const int | ERR_REQUIRES_ACTIVATION = -9 |
| static const int | ERR_LICENSE_NOT_SUITED_FOR_ACTIVATION = -10 |
| static const uint8_t | LIC_CARGO_FLAG_LIMIT_TO_FEATURES = 0x01 |
Additional Inherited Members | |
| Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| bool | _documenting |
Detailed Description
Helper class for serializing and deserializing the LicenseDescriptor JSON.
Helper C++ class to serialize and de-serialize LicenseDescriptor JSON
Example:
- See also
- TODO: engageGetActiveLicenseDescriptor, engageGetLicenseDescriptor
Definition at line 5032 of file ConfigurationObjects.h.
Constructor & Destructor Documentation
◆ LicenseDescriptor()
|
inline |
Definition at line 5118 of file ConfigurationObjects.h.
Member Function Documentation
◆ clear()
|
inline |
Definition at line 5123 of file ConfigurationObjects.h.
Member Data Documentation
◆ activationCode
| std::string AppConfigurationObjects::LicenseDescriptor::activationCode |
If the key required activation, this is the activation code generated using the entitlement, key and deviceId.
Definition at line 5083 of file ConfigurationObjects.h.
◆ cargo
| std::string AppConfigurationObjects::LicenseDescriptor::cargo |
Reserved for internal use.
Definition at line 5104 of file ConfigurationObjects.h.
◆ cargoFlags
| uint8_t AppConfigurationObjects::LicenseDescriptor::cargoFlags |
Reserved for internal use.
Definition at line 5107 of file ConfigurationObjects.h.
◆ deviceId
| std::string AppConfigurationObjects::LicenseDescriptor::deviceId |
[Read only] Unique device identifier generated by the Engine.
Definition at line 5086 of file ConfigurationObjects.h.
◆ entitlement
| std::string AppConfigurationObjects::LicenseDescriptor::entitlement |
Entitlement key to use for the product.
The entitlement key is a unique key generated by an application developer so that any license keys generated by Rally Tactical's licensing system can only be used on a product with the same matching entitlement key. E.g If you develop two products and you would like to issue license keys independently and would like the Engage Engine and licensing system to handle the entitlement, then you should generate and separate entitlement key for each application.
Definition at line 5072 of file ConfigurationObjects.h.
◆ expires
| time_t AppConfigurationObjects::LicenseDescriptor::expires |
[Read only] The time that the license key or activation code expires in Unix timestamp - Zulu/UTC.
Definition at line 5092 of file ConfigurationObjects.h.
◆ expiresFormatted
| std::string AppConfigurationObjects::LicenseDescriptor::expiresFormatted |
[Read only] The time that the license key or activation code expires formatted in ISO 8601 format, Zulu/UTC.
Definition at line 5095 of file ConfigurationObjects.h.
◆ flags
| uint32_t AppConfigurationObjects::LicenseDescriptor::flags |
◆ key
| std::string AppConfigurationObjects::LicenseDescriptor::key |
License Key to be used for the application.
This key is generated by the Rally Tactical Licensing systems and requires the entitlement key for creation. This key is then locked to the entitlement key and can never be changed.
Definition at line 5080 of file ConfigurationObjects.h.
◆ manufacturerId
| std::string AppConfigurationObjects::LicenseDescriptor::manufacturerId |
[Read only] Manufacturer ID.
Definition at line 5116 of file ConfigurationObjects.h.
◆ status
| int AppConfigurationObjects::LicenseDescriptor::status |
The current licensing status.
- See also
- Licensing Codes
Definition at line 5113 of file ConfigurationObjects.h.
◆ type
| int AppConfigurationObjects::LicenseDescriptor::type |
[Read only] 0 = unknown, 1 = perpetual, 2 = expires
Definition at line 5089 of file ConfigurationObjects.h.
The documentation for this class was generated from the following file:
- c/include/ConfigurationObjects.h
