@signiant/media-shuttle-sdk-base
Version:
The base parent sdk behind other media shuttle sdks (e.g. media-shuttle-sdk)
34 lines • 1.05 kB
TypeScript
/**
* The various states that a transfer can be in.
*/
declare enum TransferState {
/**
* The start function has been invoked but the transfer has not yet started.
*/
STARTING = "STARTING",
/**
* The transfer is in progress.
*/
IN_PROGRESS = "IN_PROGRESS",
/**
* The cancel operation has been invoked but the cancel is not yet complete.
*/
CANCELING = "CANCELING",
/**
* The transfer has ended in failure.
*
* Failed transfers can be manually retried but typically the root cause of the failure (lost internet connection,
* firewall blocking ports, bad permission set, etc.) must be addressed before the transfer can succeed.
*/
FAILURE = "FAILURE",
/**
* The transfer has been canceled by caller action.
*/
CANCELED = "CANCELED",
/**
* The transfer is successful, and the file should be present at the desired destination.
*/
SUCCESSFUL = "SUCCESSFUL"
}
export default TransferState;
//# sourceMappingURL=TransferState.d.ts.map