IBM Aspera JavaScript Library
    Preparing search index...

    Class AsperaSdkGlobals

    Index

    Constructors

    constructor

    Properties

    appId asperaAppUrl asperaAppVerified asperaSdkInfo connect? connectAW4? connectInstaller? connectStatus dropZonesCreated httpGatewayIframeContainer? httpGatewayInfo? httpGatewayRoutePrefix httpGatewayUrl? httpGatewayVerified installerUrl rpcMethods rpcPort sessionId? supportMultipleUsers

    Accessors

    sdkResponseData

    Methods

    backupLaunchMethod launch

    Constructors

    Properties

    appId: string

    The unique ID for the website

    asperaAppUrl: string = 'http://127.0.0.1'

    The URL of the IBM Aspera HTTP server to use with the SDK

    asperaAppVerified: boolean = false

    Indicate that the server has been verified as working

    asperaSdkInfo: AsperaSdkClientInfo

    Aspera SDK info

    connect?: ConnectClientType

    Connect instance

    connectAW4?: { Connect: ConnectType; ConnectInstaller: ConnectInstallerType }

    Connect raw AW4 objects

    connectInstaller?: ConnectInstallerClientType

    Connect installer instance

    connectStatus: ConnectStatusStrings = 'WAITING'

    Connect status

    dropZonesCreated: Map<
        string,
        { callback: (event: any) => void; event: string }[],
    > = ...

    Map of drop zones created by querySelector

    httpGatewayIframeContainer?: HTMLDivElement

    Http Gateway IFRAME container

    httpGatewayInfo?: HttpGatewayInfo

    HTTP Gateway info

    httpGatewayRoutePrefix: string = ''

    Version-based route prefix for HTTP Gateway API endpoints (e.g. "/v3" for v3+, "" for v2)

    httpGatewayUrl?: string

    HTTP Gateway URL after successful passing

    httpGatewayVerified: boolean = false

    Indicate that the HTTP Gateway has been verified as working

    installerUrl: string = installerUrl

    The default URL to check for latest Aspera installers

    rpcMethods: string[] = []

    The list of RPC methods supported by the running IBM Aspera for desktop application

    rpcPort: number = 33024

    The URL of the IBM Aspera Desktop HTTP server to use with the SDK

    sessionId?: string

    The session ID for the current user

    supportMultipleUsers: boolean = false

    Indicate if multiple session is supported

    Accessors

    Methods

    • Launch the IBM Aspera App via protocol url. By default, a hidden IFRAME attempts to open the app but if that fails a fallback of opening a new window happens.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods