ExecuteMailMergeRequest class

Request model for ExecuteMailMerge operation.

Implemented types

• RequestBase

Constructors

ExecuteMailMergeRequest(String? name, {String? data, FieldOptions? options, String? folder, String? storage, String? loadEncoding, String? password, String? encryptedPassword, bool? withRegions, String? mailMergeDataFile, String? cleanup, bool? useWholeParagraphAsRegion, String? destFileName})

Properties

cleanup → String?

The cleanup options.

final

data → String?

Mail merge data.

final

destFileName → String?

The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.

final

encryptedPassword → String?

Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.

final

folder → String?

Original document folder.

final

hashCode → int

The hash code for this object.

no setter, inherited

loadEncoding → String?

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

final

mailMergeDataFile → String?

The data file.

final

name → String?

The filename of the input document.

final

options → FieldOptions?

Field options.

final

password → String?

Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

storage → String?

Original document storage.

final

useWholeParagraphAsRegion → bool?

The flag indicating whether paragraph with TableStart or TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields. The default value is true.

final

withRegions → bool?

The flag indicating whether to execute Mail Merge operation with regions.

final

Methods

createRequestData(ApiClient _apiClient) → Future<ApiRequestData>

override

deserializeResponse(ApiClient _apiClient, Map<String, String> _headers, ByteData? _body) → dynamic

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited