Share via


TransferState Enum

Definition

Defines the types of the state a transfer can have.

public enum TransferState
type TransferState = 
Public Enum TransferState
Inheritance
TransferState

Fields

Name Value Description
None 0

Default value.

Queued 1

The transfer has been queued up but has not yet started.

InProgress 2

The transfer has started, but has not yet completed.

Pausing 3

The transfer is in progress and is in the process of being paused.

Transfer can be stopped if PauseTransferAsync(String, CancellationToken) or PauseAsync(CancellationToken) is called.

Stopping 4

The transfer is in progress and is in the process of being stopped.

Transfer can be stopped if StopOnAnyFailure is enabled in the ErrorMode.

Paused 5

The transfer has been paused. When transfer is paused (e.g. see PauseTransferAsync(String, CancellationToken)) during the transfer, this will be the value.

Completed 6

The transfer has come to a completed state. If the transfer has started and has fully stopped will also come to this state.

Applies to