@signiant/media-shuttle-sdk-base/dist/esm/internal/transfer/TransferConfig.d.ts

The base parent sdk behind other media shuttle sdks (e.g. media-shuttle-sdk)

export default interface TransferConfig {
    /**
     * Id of the portal which initiated this transfer request
     */
    ['com.signiant.interactivetransfer.engine.header.portalid']: string;
    /**
     * Flag to indicate whether to alidate the Server certificate
     */
    ['com.signiant.interactivetransfer.engine.certificatevalidate']: boolean;
    /**
     * A wrapper Id which identified the group of files
     */
    ['com.signiant.interactivetransfer.engine.header.packageid']: string;
    /**
     * Option to indicate whether the transfer is upload (SEND) or download (RECEIVE)
     */
    ['com.signiant.interactivetransfer.engine.mode']: string;
    /**
     * Flag to indicate whether to generate files manifest after transfer completes.
     */
    ['com.signiant.interactivetransfer.engine.generate_manifest']: boolean | string;
    /**
     * The encryption level used during transferring the files, STRONG is the only supported type
     */
    ['com.signiant.interactivetransfer.engine.encrypt']: string;
    /**
     * Endpoint to post telemetry details about transfer performance
     */
    ['app.metrics.performance.endpoint']: string;
    /**
     *  Number indicating when the transfer encounters connectivity issues how many ever times it should be retried
     */
    ['com.signiant.interactivetransfer.engine.restarts']: number;
    /**
     * Path of the subfolder under storage root where the files are gong to be download from or uploaded to
     */
    ['com.signiant.interactivetransfer.engine.dest_dir_suffix']: string;
    /**
     * File paths being transferred
     */
    ['com.signiant.interactivetransfer.engine.files']: string;
    /**
     * A unique apiKey that is used to track the transfers for billing purposes. These ApiKeys in media shuttle are tied to portals.
     */
    ['com.signiant.interactivetransfer.engine.api_key']: string;
    /**
     * A unique identifier for the transfer that is used to track the transfers when the events are fired from the app.
     */
    ['com.signiant.interactivetransfer.engine.jsId']?: string;
    ['com.signiant.interactivetransfer.engine.ca_certificate']?: string;
    ['com.signiant.interactivetransfer.engine.password']?: string;
    ['com.signiant.interactivetransfer.engine.transport']?: string;
    ['com.signiant.interactivetransfer.engine.servers']?: string;
    ['com.signiant.interactivetransfer.engine.user']?: string;
    ['com.signiant.interactivetransfer.engine.url_list']?: string;
}
//# sourceMappingURL=TransferConfig.d.ts.map