IBM Aspera JavaScript Library
    Preparing search index...

    Function getCapabilities

    • Returns an object describing the high-level capabilities supported by the user's transfer client (e.g. IBM Aspera for desktop, Connect, or HTTP Gateway).

      Use this for feature detection at a semantic level as capabilities may change depending on the transfer client.

      Rather than caching the return value of this function, it's recommended to call it on the fly as capabilities may change if your application supports multiple transfer clients. As a result, it's recommend to use the slightly more ergonomic hasCapability.

      Returns SdkCapabilities

      an object with boolean flags for each capability.

      // Conditionally render UI based on capabilities
      const caps = asperaSdk.getCapabilities();
      // Determine if your web application can render image previews for user selected files
      if (caps.imagePreview) {
      asperaSdk.readAsArrayBuffer(path);
      }