IBM Aspera JavaScript Library
    Preparing search index...

    Interface AsperaSdkSpec

    interface AsperaSdkSpec {
        allow_dialogs?: boolean;
        disableAutoDownload?: boolean;
        http_gateway_authentication?: { access_key: string; token: string };
        http_gateway_override_server_url?: string;
        http_gateway_v2_transfer_id?: string;
        preview_base64?: string;
        use_absolute_destination_path?: boolean;
    }
    Index

    Properties

    allow_dialogs? disableAutoDownload? http_gateway_authentication? http_gateway_override_server_url? http_gateway_v2_transfer_id? preview_base64? use_absolute_destination_path?

    Properties

    allow_dialogs?: boolean

    When false, IBM Aspera for desktop disables automatic UI prompts, except when the user must authorize transfers to untrusted hosts.

    disableAutoDownload?: boolean

    For HTTP Gateway downloads only. When true, the SDK obtains the presigned download URL but does not automatically initiate the browser download. Instead, the URL is returned on the resulting transfer as httpDownloadUrl so the caller can decide what to do with it.

    When set, the SDK always takes the presigned path regardless of the file size threshold. The returned transfer is not added to the SDK's transfer store and does not fire activity callbacks — the SDK has no ongoing role after returning the URL.

    http_gateway_authentication?: { access_key: string; token: string }

    HTTP Gateway Server authentication data. This will be added to transfer calls to authenticate against servers when required. Auth flows are only added when these are present here.

    Type Declaration

    • access_key: string

      Aspera Access Key

    • token: string

      Aspera Bearer Token (do not include type, only the token itself)

    http_gateway_override_server_url?: string

    HTTP Gateway Server override. This will not verify server but switch a transfer to use this server instead of the default one that initiated the SDK.

    http_gateway_v2_transfer_id?: string

    HTTP Gateway v2 transferID. This is not required for v3 gateways. This is for backwards compatibility with the old SDK.

    preview_base64?: string

    Base64 encoded preview image for the transfer. This image is displayed in the IBM Aspera transfer monitor alongside the transfer.

    use_absolute_destination_path?: boolean

    By default, the destination of a download is relative to the user's download directory setting. Setting this value to true overrides this behavior, using absolute paths instead. This is useful if you want to allow users to download files to a specific directory.

    Settings

    Member Visibility

    On This Page

    Properties