IBM Aspera JavaScript Library
    Preparing search index...

    Interface SdkCapabilities

    Describes the high-level capabilities supported by the SDK.

    interface SdkCapabilities {
        authenticate: boolean;
        fileChecksum: boolean;
        folderUpload: boolean;
        getFilesList: boolean;
        imagePreview: boolean;
        modifyTransfer: boolean;
        readDirectory: boolean;
        resumeTransfer: boolean;
        setBranding: boolean;
        showAbout: boolean;
        showDirectory: boolean;
        showPreferences: boolean;
        showSaveFileDialog: boolean;
        showTransferManager: boolean;
        showTransferMonitor: boolean;
        testSshPorts: boolean;
    }
    Index

    Properties

    authenticate fileChecksum folderUpload getFilesList imagePreview modifyTransfer readDirectory resumeTransfer setBranding showAbout showDirectory showPreferences showSaveFileDialog showTransferManager showTransferMonitor testSshPorts

    Properties

    authenticate: boolean

    Whether the transfer client supports authenticating a transfer specification.

    This is supported when using Connect or IBM Aspera for desktop.

    fileChecksum: boolean

    Whether the transfer client can calculate checksums of a file chunk.

    folderUpload: boolean

    Whether the transfer client supports uploading folders.

    This is supported when using Connect, IBM Aspera for desktop, and HTTP Gateway v3 or newer. HTTP Gateway v2 and older do not support uploading folders.

    getFilesList: boolean

    Whether the transfer client supports getting file-level progress for a given transfer.

    This is supported when using IBM Aspera for desktop.

    imagePreview: boolean

    Whether the transfer client can read file contents for generating image previews.

    This is supported when using HTTP Gateway, Connect, or IBM Aspera for desktop.

    modifyTransfer: boolean

    Whether the transfer client can modify a running transfer.

    This is supported when using Connect or IBM Aspera for desktop.

    readDirectory: boolean

    Whether the transfer client can read directory contents.

    This is only supported when using IBM Aspera for desktop.

    resumeTransfer: boolean

    Whether the transfer client resume a stopped transfer.

    This is supported when using Connect or IBM Aspera for desktop.

    setBranding: boolean

    Whether the transfer client supports customized branding settings.

    This is supported when using IBM Aspera for desktop.

    showAbout: boolean

    Whether the transfer client supports showing the about page.

    This is supported when using Connect or IBM Aspera for desktop.

    showDirectory: boolean

    Whether the transfer client supports highlighting the destination directory of the transfer using the system's file browser (ex: Finder or Windows Explorer).

    This is supported when using Connect or IBM Aspera for desktop.

    showPreferences: boolean

    Whether the transfer client supports showing the preferences page.

    This is supported when using Connect or IBM Aspera for desktop.

    showSaveFileDialog: boolean

    Whether the transfer client supports showing the save file dialog.

    This is supported when using Connect or IBM Aspera for desktop.

    showTransferManager: boolean

    Whether the transfer client supports showing the transfer manager.

    This is supported when using Connect or IBM Aspera for desktop.

    showTransferMonitor: boolean

    Whether the transfer client supports showing the transfer rate monitor.

    This is supported when using Connect or IBM Aspera for desktop.

    testSshPorts: boolean

    Whether the transfer client supports testing SSH port connectivity.

    This is supported when using Connect or IBM Aspera for desktop.

    Settings

    Member Visibility

    On This Page

    Properties