RepresentableDocumentBatch.WriteAsync

WriteAsync

Syntax

WriteAsync(<FileName>, <FileType>)

Parameters

<FileName> (required)

Type: String. Contains the full name of a file that will store the representable document batch.

<FileType> (required)

Type: RepresentableDocumentBatchFileType. Contains the file format for saving the representable document batch.

Returned value

Type: Promise. The promise execution result:

• True if saving was initiated using the browser extension and a user confirmed that they want to get the file (the file was saved).
• False if saving was initiated using the browser extension but a user did not confirm that they want to get the file (the file was not saved).
• Undefined if saving was initiated with the file download using the browser tools and it is unknown whether the file was saved.

Description

Asynchronous function. Saves a representable document batch to a file.

Availability

Thin client, web-client, mobile client, thick client, mobile application (client).

See also

RepresentableDocumentBatch, method BeginWriting RepresentableDocumentBatch, method Write

Translation

Русская версия: ПакетОтображаемыхДокументов.ЗаписатьАсинх (RepresentableDocumentBatch.WriteAsync)