IBM Aspera JavaScript Library
    Preparing search index...

    Function init

    • Initialize IBM Aspera client. If client cannot (reject/catch), then client should attempt fixing server URL or trying again. If still fails disable UI elements.

      Parameters

      • Optionaloptions: InitOptions

        initialization options:

        • appId the unique ID for the website. Transfers initiated during this session will be associated with this ID. It is recommended to use a unique ID to keep transfer information private from other websites.

        • supportMultipleUsers when enabled (defaults to false), the SDK will iterate over a port range and generate a session id to determine the running instance of the desktop app for the current user. This is needed when multiple users may be logged into the same machine simultaneously, for example on a Windows Server.

      Returns Promise<any>

      a promise that resolves if IBM Aspera Desktop is running properly or rejects if unable to connect