IBM Aspera JavaScript Library
    Preparing search index...

    Interface SdkCapabilities

    Describes the high-level capabilities supported by the SDK.

    interface SdkCapabilities {
        authenticate: boolean;
        fileChecksum: boolean;
        imagePreview: boolean;
        readDirectory: boolean;
        showAbout: boolean;
        showPreferences: boolean;
        showSaveFileDialog: boolean;
        showTransferManager: boolean;
        showTransferMonitor: boolean;
        testSshPorts: boolean;
    }
    Index

    Properties

    authenticate fileChecksum imagePreview readDirectory showAbout 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 with the required RPC methods, but not HTTP Gateway.

    fileChecksum: boolean

    Whether the SDK can calculate checksums of a file chunk.

    imagePreview: boolean

    Whether the SDK can read file contents for generating image previews.

    Image preview is supported if the SDK is using HTTP Gateway, Connect, or IBM Aspera for desktop with the required RPC methods.

    readDirectory: boolean

    Whether the SDK can read directory contents.

    This is supported when using IBM Aspera for desktop with the required RPC methods, but not Connect or HTTP Gateway.

    showAbout: boolean

    Whether the transfer client supports showing the about page.

    This is supported when using Connect or IBM Aspera for desktop with the required RPC methods, but not HTTP Gateway.

    showPreferences: boolean

    Whether the transfer client supports showing the preferences page.

    This is supported when using Connect or IBM Aspera for desktop with the required RPC methods, but not HTTP Gateway.

    showSaveFileDialog: boolean

    Whether the transfer client supports showing the save file dialog.

    This is supported when using Connect or IBM Aspera for desktop with the required RPC methods, but not HTTP Gateway.

    showTransferManager: boolean

    Whether the transfer client supports showing the transfer manager.

    This is supported when using Connect or IBM Aspera for desktop with the required RPC methods, but not HTTP Gateway.

    showTransferMonitor: boolean

    Whether the transfer client supports showing the transfer rate monitor.

    This is supported when using Connect or IBM Aspera for desktop with the required RPC methods, but not HTTP Gateway.

    testSshPorts: boolean

    Whether the transfer client supports testing SSH port connectivity.

    This is supported when using Connect or IBM Aspera for desktop with the required RPC methods, but not HTTP Gateway.

    Settings

    Member Visibility

    On This Page

    Properties