Class MediaShuttleResourceFactory

A factory class for generating resources to perform Media Shuttle actions.

Create a factory instance as follows:

Example

import { MediaShuttleResourceFactory, LoginCredentials, Explorer } from '@signiant/media-shuttle-sdk';
const loginCredentials:LoginCredentials = new LoginCredentials({
  username: 'sample.user@signiant.com',
  password: 'replace_with_real_password'
});
const resourceFactory:MediaShuttleResourceFactory = new MediaShuttleResourceFactory(loginCredentials, {});

Hierarchy

  • MediaShuttleResourceFactory

Constructors

constructor

Methods

generateDownload generateUpload getExplorer

Constructors

constructor

Methods

generateDownload

  • See the Explorer documentation on how to make calls to find the necessary input (portalId, files, serviceId, accountId) for Download generation.

    Example

    import { MediaShuttleResourceFactory, Download, DownloadOptions } from '@signiant/media-shuttle-sdk'
    createDownload (resourceFactory: MediaShuttleResourceFactory, portalId: string, files: RemoteFile[], serviceId: string, accountId: string): Promise<Download> {
      const downloadOptions: DownloadOptions = {
          portalId,
          files,
          serviceId,
          accountId,
      }
      return resourceFactory.generateDownload(downloadOptions);
    }

    Returns

    The Download transfer object.

    Parameters

    Returns Promise<Download>

generateUpload

  • See the Explorer documentation on how to make calls to find the necessary input (portalId, accountId and serviceId) for Upload generation.

    Example

    import { MediaShuttleResourceFactory, Upload, PlatformTransferOptions } from '@signiant/media-shuttle-sdk'
    createUpload (resourceFactory: MediaShuttleResourceFactory, portalId: string, serviceId: string, accountId: string): Promise<Upload> {
      const uploadOptions: PlatformTransferOptions = {
          portalId,
          serviceId,
          accountId,
      }
      return resourceFactory.generateUpload(uploadOptions);
    }

    Returns

    The Upload transfer object.

    Parameters

    Returns Promise<Upload>

getExplorer

Settings

Theme

Generated using TypeDoc