Interface Transfer

An interface that defines all of the function that can be performed against a transfer.

Hierarchy

Transfer
- Download
- Upload

Index

Accessors

currentTransferState transferId

Methods

cancel retry start unsubscribeAll

Accessors

currentTransferState

get currentTransferState(): TransferState
Returns
The current TransferState of the transfer.

Returns TransferState

transferId

get transferId(): string
Returns
The unique identifier for this transfer

Example
```
2ccc5d48-e43b-40b7-bb70-f591dc51c293
```
Returns string

Methods

cancel

cancel(): Promise<void>
Cancel the transfer. Valid in the following states:
- STARTING,
- QUEUED,
- IN_PROGRESS
Returns
A Promise which will resolve when the transfer has canceled successfully.
Returns Promise<void>

retry

retry(): Promise<void>
Retry the incomplete transfer. Valid in the following states
- FAILURE
- CANCELED
Returns
A Promise which will resolve when the retry has been successfully initiated.
Returns Promise<void>

start

start(): Promise<void>
Start the transfer. Valid in the following states:
- IDLE
Returns
A Promise which will resolve when the transfer has started successfully.
Returns Promise<void>

unsubscribeAll

unsubscribeAll(): boolean
Returns
true when 1 or more listeners were removed.

Returns boolean

Generated using TypeDoc