TransferManager.PauseTransferIfRunningAsync(String, CancellationToken) Method

Definition

Attempts to pause the transfer of the respective id.

public virtual System.Threading.Tasks.Task PauseTransferIfRunningAsync (string transferId, System.Threading.CancellationToken cancellationToken = default);
abstract member PauseTransferIfRunningAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.PauseTransferIfRunningAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function PauseTransferIfRunningAsync (transferId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

transferId
String

The id of the transfer to pause.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

Return true once the transfer has been successfully paused or false if the transfer was already completed.

Applies to