License File

For more info see:

• https://docs.licensespring.com/sdks/tutorials/best-practices/local-license-file

• https://docs.licensespring.com/sdks/python/licensefile

To load a local license file, create an instance of LicenseManager and call the method loadLicense:

example.js

const licenseFile = licenseManager.loadLicense();

The License class provides an interface for working with the License File.

Methods

Create Offline Request File

Creates an activate_offline.req or deactivate_offline.req file for offline activation/deactivation at the specified path:

signature.ts

createRequestFile(request: OfflineActivation, offlinePath: string)

Type declaration for OfflineActivation:

types.ts

interface OfflineActivation {
  isActivation: boolean; // true for activation, false for deactivation
  isGuardFileEnabled: boolean; // should a guard file be created
  guard: any // guard file data if required, created using: licenseAPI.createActivationGuard(licenseKey)
  data: { // license data
    product: string,
    hardware_id: string,
    license_key?: string,
    license_id?: number,
    username?: string,
    password?: string,
    app_ver?: string,
    os_ver?: string,
    hostname?: string,
    ip?: string,
    is_vm?: boolean,
    vm_info?: string,
    mac_address?: string,
    variables?: {
      [key: string]: boolean | number | string
    },
  };
}

Get Feature Data

signature.ts

featureData(featureCode: string): ProductFeature

Check License Status

Throws an exception if the license is disabled, inactive or expired

signature.ts

checkLicenseStatus(): void

Perform Full License Check

Checks License status and saves to local license file

signature.ts

check(includeExpiredFeatures: boolean = false): Promise<LicenseResponse>

Air-Gap License Activation Code

For more info see: https://docs.licensespring.com/license-entitlements/activation-types/air-gapped

signatures.ts

getDeactivationCode(initializationCode: string): string

deactivateAirGap(confirmationCode: string): void

Deactivate License

Deactivates a License, updates local license file. Optionally deletes license file

signature.ts

deactivate(deleteLicense: boolean = false): Promise<boolean>

Local License Check

Performs a local check using the local license file. Throws an exception if license is not valid

signature.ts

localCheck(): Promise<true>

Change Password

Performs password change for user associated to License

signature.ts

changePassword(oldPassword: string, newPassword: string): Promise<boolean>

Add Local Consumption

Adds a License consumption to the local license data

signature.ts

addLocalConsumption(consumptions: number = 1)

Add Local Feature Consumption

Adds a License feature consumption to the local license data

signature.ts

addLocalFeatureConsumption(featureCode: string, consumptions: number = 1)

Sync License Feature Consumption

Sends a feature consumption request to the server and updates local data

signature.ts

syncFeatureConsumption(feature: { code: string, local_consumption: number }): Promise<boolean>

Sync License Consumptions

Syncs local consumptions to server

signature.ts

syncConsumption(overages: number = -1): Promise<boolean>

Borrow Floating License

signature.ts

floatingBorrow(borrowUntil: string, password?: string): Promise<boolean>

Release Floating License

signature.ts

floatingRelease(): Promise<boolean>

Check Feature

Checks License Feature status, throws exception if not active

signature.ts

checkFeature(featureCode: string): Promise<void>

Release Borrowed Feature

signature.ts

releaseFeature(featureCode: string): Promise<void>

Update Offline

Update local cache from Offline License File (at given path). Optionally reset local consumption value

signature.ts

updateOffline(path: string, resetConsumption: boolean): boolean

Deactivate License Offline

signature.ts

deactivateOffline(offlinePath: string): Promise<void>

Get Product Details

Retrieves Product Details from server:

signature.ts

productDetails(includeLatestVersion: boolean = false, includeCustomFields: boolean = false, includeExpiredFeatures: boolean = false): Promise<ProductDetailsResponse>

Retrieve Product Details from local data:

getter.ts

get productDetailsLocal()

Device Variables

Set custom variables to local data:

signature.ts

setDeviceVariablesLocal(variables: { [key: string]: string|number }, save: boolean = true): void

Send locally stored variables to server, optionally save to license file:

signature.ts

setDeviceVariables(save: boolean = false): Promise<void>

Get the value of a variable from local data:

signature.ts

getDeviceVariableLocal(variable: string)

Get all variables from local data:

signature.ts

getDeviceVariablesLocal()

Get all variables from server:

signature.ts

getDeviceVariables(): Promise<DeviceVariable[]>

Getters

getters.js

get allowGraceSubscriptionPeriod()
get allowOverages()
get allowUnlimitedActivations()
get allowUnlimitedConsumptions()
get borrowUntil()
get consumptionPeriod()
get consumptionReset()
get customerInformation()
get customFields()
get daysRemaining()
get daysSinceLastCheck()
get expiryDate()
get features()
get floatingClientId()
get floatingEndDate()
get floatingInUseDevices()
get floatingTimeout()
get gracePeriod()
get gracePeriodHoursRemaining()
get id()
get isAirGapped()
get isBorrowed()
get isControlledByFloatingServer()
get isDeviceTransferAllowed()
get isDeviceTransferLimited()
get isExpired()
get isFloating()
get isFloatingExpired()
get isGracePeriod()
get isGracePeriodStarted()
get isMaintenancePeriodExpired()
get isSubcriptionGracePeriodStarted()
get isTrial()
get isValid()
get isValidityPeriodExpired()
get lastCheck()
get lastUsage()
get licenseActive()
get licenseEnabled()
get licenseKey()
get licenseType()
get licenseUser()
get localConsumptions()
get maintenanceDaysRemaining()
get maintenancePeriod()
get maxActivations()
get maxConsumptions()
get maxFloatingUsers()
get maxOverages()
get maxTransfers()
get metadata()
get policyID()
get preventVm()
get startDate()
get subscriptionGracePeriod()
get totalConsumptions()
get transferCount()
get validityPeriod()
get validityWithGracePeriod()