Edit

Share via

Word.DocumentCheckInOptions 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.checkIn method.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

comment

If provided, specifies a comment for the check-in operation.
makePublic

If provided, specifies whether to make the document public after check-in. The default value is false.
saveChanges

If provided, specifies whether to save changes before checking in. The default value is true.

Property Details

comment

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 a comment for the check-in operation.

comment?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

makePublic

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 make the document public after check-in. The default value is false.

makePublic?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

saveChanges

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 save changes before checking in. The default value is true.

saveChanges?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]