DocuwareClient.DownloadFileAsync Method

Definition

Download a file

public virtual System.Threading.Tasks.Task<byte[]> DownloadFileAsync(string fileCabinetDocumentTray, int documentId, string fileNumber, string documentFormat, System.Threading.CancellationToken cancellationToken = default);
abstract member DownloadFileAsync : string * int * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<byte[]>
override this.DownloadFileAsync : string * int * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<byte[]>
Public Overridable Function DownloadFileAsync (fileCabinetDocumentTray As String, documentId As Integer, fileNumber As String, documentFormat As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Byte())

Parameters

fileCabinetDocumentTray
String

File Cabinet/Document Tray

documentId
Int32

Document ID

fileNumber
String

File Number

documentFormat
String

Document Format

cancellationToken
CancellationToken

Cancellation token.

Returns

Task<Byte[]>

The Download a file response.

Remarks

Downloads a file/section of a document stored in a file cabinet or document tray.

Applies to