Information about the SDK license.

Constructors

Properties

deviceDeregistationErrors: DeviceDeregistrationError[]

List of errors that occurred during device deregistration. If for some device deregistration completed successfully, it will not be listed here. For each device at most one entry will be present.

devices: null | number

Number of devices the license is valid for, if the license is floating.

errorMessage: string

Additional error message in case of a license error.

expirationDateString: string

Expiration date of the license or trial period in ISO 8601 date-time format.

expirationTimestamp: number

Expiration timestamp of the license or trial period in seconds since the UNIX epoch.

isValid: boolean

True if the license status corresponds to a valid license.

license: string

The currently active license. May be different from the license used to initialize the SDK if the online license check has completed and the server has sent an updated license.

licenseStatusMessage: string

Message describing the license status.

nextOnlineLicenseCheckInMs: number

Time in milliseconds until the next online license check will be performed. -1 if no online license check is scheduled.

onlineLicenseCheckInProgress: boolean

True if an online license check is in progress.

License status.

Methods

  • Parameters

    Returns {
        deviceDeregistationErrors?: {
            deviceId?: number;
            errorMessage?: string;
            serialize?(config?): { readonly deviceId?: number | undefined; readonly errorMessage?: string | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
        }[];
        devices?: null | number;
        errorMessage?: string;
        expirationDateString?: string;
        expirationTimestamp?: number;
        isValid?: boolean;
        license?: string;
        licenseStatusMessage?: string;
        nextOnlineLicenseCheckInMs?: number;
        onlineLicenseCheckInProgress?: boolean;
        status?: LicenseStatus;
        serialize?(config?): { readonly status?: LicenseStatus | undefined; readonly isValid?: boolean | undefined; readonly licenseStatusMessage?: string | undefined; readonly expirationTimestamp?: number | undefined; ... 7 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
    }

    • Optional Readonly deviceDeregistationErrors?: {
          deviceId?: number;
          errorMessage?: string;
          serialize?(config?): { readonly deviceId?: number | undefined; readonly errorMessage?: string | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      }[]

      List of errors that occurred during device deregistration. If for some device deregistration completed successfully, it will not be listed here. For each device at most one entry will be present.

    • Optional Readonly devices?: null | number

      Number of devices the license is valid for, if the license is floating.

    • Optional Readonly errorMessage?: string

      Additional error message in case of a license error.

    • Optional Readonly expirationDateString?: string

      Expiration date of the license or trial period in ISO 8601 date-time format.

    • Optional Readonly expirationTimestamp?: number

      Expiration timestamp of the license or trial period in seconds since the UNIX epoch.

    • Optional Readonly isValid?: boolean

      True if the license status corresponds to a valid license.

    • Optional Readonly license?: string

      The currently active license. May be different from the license used to initialize the SDK if the online license check has completed and the server has sent an updated license.

    • Optional Readonly licenseStatusMessage?: string

      Message describing the license status.

    • Optional Readonly nextOnlineLicenseCheckInMs?: number

      Time in milliseconds until the next online license check will be performed. -1 if no online license check is scheduled.

    • Optional Readonly onlineLicenseCheckInProgress?: boolean

      True if an online license check is in progress.

    • Optional Readonly status?: LicenseStatus

      License status.

    • serialize?:function
      • Parameters

        Returns { readonly status?: LicenseStatus | undefined; readonly isValid?: boolean | undefined; readonly licenseStatusMessage?: string | undefined; readonly expirationTimestamp?: number | undefined; ... 7 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }