Edit

Share via

Word.DocumentEndReviewOptions interface

Package:
word

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Provides configuration options for the Document.endReview method.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

includeAttachment

If provided, specifies whether to include the document as an attachment. The default value is true.
recipients

If provided, specifies the recipients to notify when ending the review. The default value is an empty string.
showMessage

If provided, specifies whether to show the message before sending. The default value is true.
subject

If provided, specifies the subject of the notification email. The default value is an empty string.

Property Details

includeAttachment

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to include the document as an attachment. The default value is true.

includeAttachment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

recipients

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the recipients to notify when ending the review. The default value is an empty string.

recipients?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

showMessage

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to show the message before sending. The default value is true.

showMessage?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

subject

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the subject of the notification email. The default value is an empty string.

subject?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]