CallingServerClient.DownloadToAsync Method

Definition

Namespace:

Azure.Communication.CallingServer

Assembly:

Azure.Communication.CallingServer.dll

Package:

Azure.Communication.CallingServer v1.0.0-beta.3

Overloads

DownloadToAsync(Uri, Stream, ContentTransferOptions, CancellationToken)	The DownloadToAsync(Uri, Stream, ContentTransferOptions, CancellationToken) operation downloads the specified content using parallel requests, and writes the content to destinationStream.
DownloadToAsync(Uri, String, ContentTransferOptions, CancellationToken)	The DownloadToAsync(Uri, String, ContentTransferOptions, CancellationToken) operation downloads the specified content using parallel requests, and writes the content to destinationPath.

DownloadToAsync(Uri, Stream, ContentTransferOptions, CancellationToken)

Source:

CallingServerClient.cs

The DownloadToAsync(Uri, Stream, ContentTransferOptions, CancellationToken) operation downloads the specified content using parallel requests, and writes the content to destinationStream.

public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (Uri sourceEndpoint, System.IO.Stream destinationStream, Azure.Communication.CallingServer.ContentTransferOptions transferOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DownloadToAsync : Uri * System.IO.Stream * Azure.Communication.CallingServer.ContentTransferOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadToAsync : Uri * System.IO.Stream * Azure.Communication.CallingServer.ContentTransferOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DownloadToAsync (sourceEndpoint As Uri, destinationStream As Stream, Optional transferOptions As ContentTransferOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

sourceEndpoint

Uri

A Uri with the Recording's content's url location.

destinationStream

Stream

A Stream to write the downloaded content to.

transferOptions

ContentTransferOptions

Optional ContentTransferOptions to configure parallel transfer behavior.

cancellationToken

CancellationToken

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

Returns

Task<Response>

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

DownloadToAsync(Uri, String, ContentTransferOptions, CancellationToken)

Source:

CallingServerClient.cs

The DownloadToAsync(Uri, String, ContentTransferOptions, CancellationToken) operation downloads the specified content using parallel requests, and writes the content to destinationPath.

public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (Uri sourceEndpoint, string destinationPath, Azure.Communication.CallingServer.ContentTransferOptions transferOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DownloadToAsync : Uri * string * Azure.Communication.CallingServer.ContentTransferOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadToAsync : Uri * string * Azure.Communication.CallingServer.ContentTransferOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DownloadToAsync (sourceEndpoint As Uri, destinationPath As String, Optional transferOptions As ContentTransferOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

sourceEndpoint

Uri

A Uri with the Recording's content's url location.

destinationPath

String

A file path to write the downloaded content to.

transferOptions

ContentTransferOptions

Optional ContentTransferOptions to configure parallel transfer behavior.

cancellationToken

CancellationToken

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

Returns

Task<Response>

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.