Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Browser

Hierarchy

  • Browser

Index

Properties

Accessors

Properties

activityTracking

activityTracking: ActivityTracking = new ActivityTracking()

Activity tracking for watching transfers

createDropzone

createDropzone: (callback: (data: { event: any; files: DataTransferResponse }) => void, elementSelector: string) => void

Create dropzone for drop events of files

Type declaration

deregisterActivityCallback

deregisterActivityCallback: (id: string) => void

Deregister callback to remove it from the callbacks getting transfer data

Type declaration

    • (id: string): void

    • Parameters

      • id: string

      Returns void

deregisterRemovedCallback

deregisterRemovedCallback: (id: string) => void

Deregister callback to remove it from the callbacks getting removed transfer data

Type declaration

    • (id: string): void

    • Parameters

      • id: string

      Returns void

deregisterSafariExtensionStatusCallback

deregisterSafariExtensionStatusCallback: (id: string) => void

Deregister callback to remove it from the callbacks getting Safari extension events

Type declaration

    • (id: string): void

    • Parameters

      • id: string

      Returns void

deregisterStatusCallback

deregisterStatusCallback: (id: string) => void

Deregister callback to remove it from the callbacks getting connection events

Type declaration

    • (id: string): void

    • Parameters

      • id: string

      Returns void

getAllTransfers

getAllTransfers: () => Promise<BrowserTransfer[]>

Function to get a list of all transfers

Type declaration

getInfo

getInfo: () => Promise<BrowserInfo>

Function to get information about the IBM Aspera Browser instance

Type declaration

getInstallerInfo

getInstallerInfo: (options: InstallerOptions) => Promise<InstallerInfoResponse>

Function to get latest installer information

Type declaration

getTransfer

getTransfer: (transferId: string) => Promise<BrowserTransfer>

Function to get information for a specific transfer

Type declaration

globals

globals: BrowserGlobals = new BrowserGlobals()

Global information about IBM Aspera Browser

init

init: (options: InitOptions) => Promise<any>

Function to initialize IBM Aspera Browser

Type declaration

initDragDrop

initDragDrop: () => Promise<any>

Initialize drag and drop

Type declaration

    • (): Promise<any>

    • Returns Promise<any>

isSafari

isSafari: () => boolean

Function to get whether IBM Aspera Browser is running on Safari

Type declaration

    • (): boolean

    • Returns boolean

launch

launch: () => void

Function to launch IBM Aspera Browser

Type declaration

    • (): void

    • Returns void

modifyTransfer

modifyTransfer: (transferId: string, options: ModifyTransferOptions) => Promise<BrowserTransfer>

Function to modify a running transfer

Type declaration

registerActivityCallback

registerActivityCallback: (callback: (transfers: TransferResponse) => void) => string

Register callback for the transfer activity monitor

Type declaration

registerRemovedCallback

registerRemovedCallback: (callback: (transfer: BrowserTransfer) => void) => string

Register callback for removed transfers from the app

Type declaration

registerSafariExtensionStatusCallback

registerSafariExtensionStatusCallback: (callback: (status: SafariExtensionEvent) => void) => string

Register callback for Safari extension status events

Type declaration

registerStatusCallback

registerStatusCallback: (callback: (status: WebsocketEvent) => void) => string

Register callback for connection status events from the app

Type declaration

removeDropzone

removeDropzone: (elementSelector: string) => void

Remove dropzone for drop events of files

Type declaration

    • (elementSelector: string): void

    • Parameters

      • elementSelector: string

      Returns void

removeTransfer

removeTransfer: (transferId: string) => Promise<any>

Function to remove a transfer

Type declaration

    • (transferId: string): Promise<any>

    • Parameters

      • transferId: string

      Returns Promise<any>

resumeTransfer

resumeTransfer: (transferId: string, options?: ResumeTransferOptions) => Promise<BrowserTransfer>

Function to resume a transfer

Type declaration

setBranding

setBranding: (id: string, options: CustomBrandingOptions) => Promise<any>

Function to set custom branding for IBM Aspera Browser

Type declaration

showDirectory

showDirectory: (transferId: string) => Promise<any>

Function to show the transfer's download directory in Finder or Windows Explorer

Type declaration

    • (transferId: string): Promise<any>

    • Parameters

      • transferId: string

      Returns Promise<any>

showPreferences

showPreferences: () => Promise<any>

Function to display the IBM Aspera Browser preferences page

Type declaration

    • (): Promise<any>

    • Returns Promise<any>

showSelectFileDialog

showSelectFileDialog: (options?: FileDialogOptions) => Promise<DataTransferResponse>

Function to display a file dialog for the user to select files.

Type declaration

showSelectFolderDialog

showSelectFolderDialog: (options?: FolderDialogOptions) => Promise<DataTransferResponse>

Function to display a folder dialog for the user to select folders.

Type declaration

startTransfer

startTransfer: (transferSpec: TransferSpec, browserSpec: BrowserSpec) => Promise<BrowserTransfer>

Function to initiate a transfer

Type declaration

stopTransfer

stopTransfer: (transferId: string) => Promise<any>

Function to stop a transfer

Type declaration

    • (transferId: string): Promise<any>

    • Parameters

      • transferId: string

      Returns Promise<any>

testConnection

testConnection: () => Promise<any>

Function to test the IBM Aspera Browser status

Type declaration

    • (): Promise<any>

    • Returns Promise<any>

Accessors

isReady

  • get isReady(): boolean

  • Check if IBM Aspera Browser is ready to be used and has been verified.

    Returns boolean

    a boolean indicating if SDK can be used for requests