`Dynamsoft.DWT`

Global properties and functions.

interface Dynamsoft.DWT {
    readonly licenseException: string;
    
    readonly ActiveXVersion: string;
    readonly JSVersion: string;
    readonly PdfVersion: string;
    readonly ServerLinuxVersionInfo: string;
    readonly ServerMacVersionInfo: string;
    readonly ServerVersionInfo: string;
    /**
     * Whether to create a WebTwain instance automatically.
     */
    AutoLoad: boolean;
    ContainerMap: object;
    /**
     * Define the friendly name to the specified client device.
     */
    DeviceFriendlyName: string;
    /**
     * Define the Id and UI of the WebTwain instances.
     */
    Containers: Container[];
    Host: string; //"local.dynamsoft.com"
    IfAddMD5InUploadHeader: boolean;
    IfDisableDefaultSettings: boolean;
    IfUseActiveXForIE10Plus: boolean;
    readonly inited: boolean;
    ProductKey: string;
    ResourcesPath: string;
    
    // Functions
    CreateDWTObject(
        ContainerId: string, 
        host?: string, 
        port?: string | number, 
        portSSL?: string | number, 
        asyncSuccessFunc: function (DWObject: WebTwain) {}, 
        asyncFailureFunc: function (errorString: string) {}
    ): void;
    CreateDWTObjectEx(
        dwtInitialConfig: DWTInitialConfig,                 
        asyncSuccessFunc: (DWObject: WebTwain) => {},                   
        asyncFailureFunc: (errorString: string) => {}
    ): void;
    DeleteDWTObject(Id?: string): boolean;
    GetWebTwain(ContainerId?: string): WebTwain;
    GetWebTwainEx(WebTwainId: string): WebTwain;
    Load(): void;
    Unload(): void;
    RemoveAllAuthorizations: function () {};    
    OnWebTwainNotFound: function () {};
    OnWebTwainPostExecute: function () {};
    OnWebTwainPreExecute: function () {};
    OnWebTwainReady: function () {};
    OnWebTwainWillInit: function () {};
}

/**
 * Update and download cert to DynamsoftServicex64_17\cert 
 */
UpdateCert(
    url: string, // url to download the new certificate. 
    optionalAsyncSuccessFunc?: function () {}, 
    optionalAsyncFailureFunc?: function (errorCode: number, errorString: string) {}
);

licenseException

Syntax

/**
 * Error message related to license.
 */
licenseException: string;

Usage notes

Check license error list

Options

`Containers`

An array of Container definitions that specifies the UI elements for WebTwain instances. The Container interface is defined below

interface Container {
    WebTwainId?: string, // Id of the WebTwain instance
    ContainerId?: string, // Id of the element
    Width?: string | number, // Width of the element
    Height?: string | number // Height of the element
}

WebTwainId and ContainerId are both optional but one must exist as the identifier for that WebTwain instance.

Width and Height determine the initial viewer size of the instance.

`IfAddMD5InUploadHeader`

Whether or not an md5 header dwt-md5 should be included in HTTP upload requests. Note that this header is not a standard header and may be deemed invalid on some web servers.

The default value is false .

`ProductKey`

Sets or returns the product key for the library. A product key is required to enables certain modules of the library.

`ResourcesPath`

Sets or returns where the library looks for resources files including service installers, CSS, etc.

Functions

`UpdateCert`

Syntax

/**
 * Update and download certificate (server.pem.ldsc & server_key.pem.ldsc) to DynamsoftServicex64_17\cert.
 * @param url Url to download the new certificate. E.g. http://download.dynamsoft.com/cert.zip. server.pem.ldsc & server_key.pem.ldsc should be in cert.zip. 
 * @param successCallback A callback function that is executed if the request succeeds.
 * @param failureCallback A callback function that is executed if the request fails.
 * @argument errorCode The error code.
 * @argument errorString The error string.
 */
UpdateCert(
        url: string,
        optionalAsyncSuccessFunc?: () => void,
        optionalAsyncFailureFunc?: (
            errorCode: number, 
            errorString: string) => void
    );

Availability

ActiveX	H5(Windows)	H5(macOS/TWAIN)	H5(macOS/ICA)	H5(Linux)
not supported	v17.2+	v17.2+	v17.2+	v17.2+

Example

// overwrite the following function in dynamsoft.webtwain.install.js
   Dynamsoft.OnSSLCertInfo = function (sslExpiredDate) {
        console.log(sslExpiredDate);
   Dynamsoft.DWT.UpdateCert("https://domainlocation.com/cert.zip", 
        function () { console.log("OK"); }, 
        function (errorCode, errorString) { console.log(errorString);}
    );
  };

`CreateDWTObject()`

Creates a new WebTwain instance that listens to the specified host & ports. An UI element specified by the parameter ContainerId which is typically a <div> is required. The library will generate a UI and bind it to this element.

`CreateDWTObjectEx()`

Creates a new UI-less WebTwain instance. This instance will be uniquely identified by the parameter WebTwainId .

interface DWTInitialConfig {
    WebTwainId: string,
        Host ? : string,
        Port ? : string,
        PortSSL ? : string,
}

`DeleteDWTObject()`

Delete the WebTwain instance specified by Id which can either be a ContainerId or a WebTwainId .

`GetWebTwain()`

Gets an WebTwain instance by its ContainerId .

`GetWebTwainEx()`

Gets an WebTwain instance by its WebTwainId .

`Load()`

Initiates the library. If there are predefined Containers , one WebTwain instance will be created for each Container .

`RegisterEvent()`

Registers an environmental event. Typically the event is OnWebTwainReady which is triggered when the initialization completes.

`Unload()`

Destroys all WebTwain instances and cuts off the connection to the Dynamsoft Service.

`RemoveAllAuthorizations()`

Removes the specific authorizations made by end users on a client machine. Only effective when the security feature is enabled for local files, scanners or cameras.

`UseDefaultViewer`

Whether to use the built-in viewer. If it is set to false , the file dynamsoft.viewer.js is not loaded at all and there is no way to add it back later. Therefore, only set it to false when you absolutely won’t need the viewer or will be building your own viewer.

`CustomizableDisplayInfo`

Use this API to customize the UI.

`errorMessages`

Specify the error messages.

`generalMessages`

Specify general messages.

`customProgressText`

Specify text on progress bars.

`buttons`

Specify the titles and whether to show one or multiple buttons on the image editor.

`dialogText`

Specify the text on dialogs.

`loaderBarSource`

Specify the source of the loader bar image. Check out more on HTMLImageElement.src.

`loaderBarClassName`

Specify the class name of the DIV element that contains the loader bar. With this class, you can customize the loader bar even further with CSS.