Edit

Share via

Word.DocumentCheckInWithVersionOptions 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.checkInWithVersion 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.
versionType

If provided, specifies the version type for the check-in. The default value is minorVersion.

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) ]

versionType

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 version type for the check-in. The default value is minorVersion.

versionType?: Word.CheckInVersionType | "Minor" | "Major" | "Overwrite";

Property Value

Word.CheckInVersionType | "Minor" | "Major" | "Overwrite"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]