LicenseManager

The LicenseManager class provides a set of APIs to manage the licensing for the Dynamsoft Capture Vision architecture.

getDeviceUUID

Returns the unique identifier of the device.

static getDeviceUUID(): Promise<string>;

Return Value

A promise which, upon resolution, yields a string corresponding to the device’s UUID.

initLicense

Initializes the license for the application using a license key. This function is overloaded, providing two different usages based on the provided parameters.

static initLicense(license: string, options?: {executeNow: boolean} | boolean): void | Promise<void>;

Parameters

license: The license key to be used for initialization.

options: It can be one of two types, a boolean or an object with a single property, executeNow, which is a boolean. If options is true or { executeNow: true }, the license initialization action will be executed immediately.

Return Value

void

• When options is undefined or false, this signature of initLicense passes the license key to the application for initialization at a later stage. It doesn’t provide immediate feedback and is suitable for scenarios where immediate confirmation of license initialization is not required.

• When options is set to {executeNow: true}, this returns a promise that resolves when the operation finishes. It does not provide any value upon resolution. Please note that it may raise up license related exceptions.

Code snippet

Dynamsoft.License.LicenseManager.initLicense("your-license-key", {executeNow: true})
  .then(result => {
    if (result?.message) {
      console.log("License Message:", result.message);
    } else {
      console.log("License initialized successfully");
    }
  })
  .catch(error => {
    console.error("License initialization failed:", error);
  });

setDeviceFriendlyName

Assigns a distinctive name to the device, correlating it with its UUID.

Please be aware that this method must be called before Dynamsoft.CVR.CaptureVisionRouter.createInstance() or Dynamsoft.Core.CoreModule.loadWasm() or Dynamsoft.DCP.CodeParser.createInstance() to take effect.

static setDeviceFriendlyName(name: string): void;

Parameters

name: A string representing the device which is easier to recognize than its UUID. The maximum length of the string is 255 characters and the null character “\0” is not allowed.

Return Value

void