IBM Aspera JavaScript Library
    Preparing search index...

    Interface InitOptions

    interface InitOptions {
        appId?: string;
        connectSettings?: {
            correlationId?: string;
            dragDropEnabled?: boolean;
            fallback?: boolean;
            hideIncludedInstaller?: boolean;
            method?: "http" | "extension";
            minVersion?: string;
            sdkLocation?: string;
            useConnect: boolean;
            version?: string;
        };
        httpGatewaySettings?: { forceGateway: boolean; url: string };
        retryInterval?: number;
        retryTimeout?: number;
        supportMultipleUsers?: boolean;
    }
    Index

    Properties

    appId? connectSettings? httpGatewaySettings? retryInterval? retryTimeout? supportMultipleUsers?

    Properties

    appId?: string

    The application ID to link to. This should be unique for each use app/user.

    connectSettings?: {
        correlationId?: string;
        dragDropEnabled?: boolean;
        fallback?: boolean;
        hideIncludedInstaller?: boolean;
        method?: "http" | "extension";
        minVersion?: string;
        sdkLocation?: string;
        useConnect: boolean;
        version?: string;
    }

    Connect Settings

    Type Declaration

    • OptionalcorrelationId?: string

      Correlation ID for connecting to IBMid users

    • OptionaldragDropEnabled?: boolean

      Indicate if Drag and Drop is enabled

    • Optionalfallback?: boolean

      Try Desktop first, fall back to Connect if Desktop is unavailable within the retry timeout. Ignored when useConnect is true.

    • OptionalhideIncludedInstaller?: boolean

      Indicate if default Connect installer window should not be shown

    • Optionalmethod?: "http" | "extension"

      Method for Connect communication. Default is extension

    • OptionalminVersion?: string

      Minimum version of Connect to allow

    • OptionalsdkLocation?: string

      Location of SDK for downloads

    • useConnect: boolean

      Use connect. Indicate if Connect should be used instead of Desktop.

    • Optionalversion?: string

      Connect installer version to offer for downloads. This option is ignored if sdkLocation is specified. Only supports versions 4.x.x.

    httpGatewaySettings?: { forceGateway: boolean; url: string }

    HTTP Gateway Settings

    Type Declaration

    • forceGateway: boolean

      Indicate if HTTP Gateway should be forced. This will not start desktop if httpGatewayUrl is valid.

    • url: string

      Aspera HTTP Gateway URL to use if desktop is not available. Include gateway route but not versions (example: https://example.com/aspera/http-gwy).

    retryInterval?: number

    Interval in ms between detection attempts. Default: 2000.

    retryTimeout?: number

    Timeout in ms before status transitions to FAILED. Default: 5000.

    supportMultipleUsers?: boolean

    Indicate if the computer is running multiple users possibly (avoid port crossing).

    Settings

    Member Visibility

    On This Page

    Properties