Module: siteKiosk.license

This module provides license related functions. The copy of SiteKiosk can be registered via this module, and if the product is already registered, information about the license can be obtained here. An internet connection is required for the registration process.

Example

//register with given key and print name the license is registered to
siteKiosk.license.registerLicense("V4L1D-K3Y", function(licenseData) {
    console.log("Licensed to: "+licenseData.LicenseName);
});

Methods

<static> getRegisteredLicense() → {siteKiosk.license~licenseData}

Returns the currently active license.
Returns:
Type
siteKiosk.license~licenseData

<static> isFullVersion() → {boolean}

Returns true, if this is a full version installation.
Returns:
Whether this is a full version or not
Type
boolean

<static> isLiteVersion() → {boolean}

Returns true, if this is a lite version installation.
Returns:
Whether this is a lite version or not
Type
boolean

<static> registerLicense(key, callback)

Registers a new license key.
Parameters:
Name Type Description
key string The license key to use for the registration process
callback siteKiosk.license~registeredCallback A callback, which will be triggered when a license is registered

Type Definitions

licenseData

The license data.
Type:
  • Object
Properties:
Name Type Description
SupportedClients number Maximum allowed clients being run with this license
LicenseName string The name this license is registered to
LicenseKey string The key of this license

registeredCallback(licenseData)

This callback will be triggered when a license is registered.
Parameters:
Name Type Description
licenseData siteKiosk.license~licenseData The license data