Edit

Share via

Word.Interfaces.CoauthoringData interface

Package:
word

An interface describing the data returned by calling coauthoring.toJSON().

Properties

authors

Gets a CoauthorCollection object that represents all the coauthors currently editing the document.
canCoauthor

Gets whether this document can be coauthored.
canMerge

Gets whether the document can be automatically merged.
conflicts

Gets a ConflictCollection object that represents all the conflicts in the document.
locks

Gets a CoauthoringLockCollection object that represents the locks in the document.
me

Gets a Coauthor object that represents the current user.
pendingUpdates

Gets whether the document has pending updates that have not been accepted.
updates

Gets a CoauthoringUpdateCollection object that represents the most recent updates that were merged into the document.

Property Details

authors

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.

Gets a CoauthorCollection object that represents all the coauthors currently editing the document.

authors?: Word.Interfaces.CoauthorData[];

Property Value

Word.Interfaces.CoauthorData[]

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

canCoauthor

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.

Gets whether this document can be coauthored.

canCoauthor?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

canMerge

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.

Gets whether the document can be automatically merged.

canMerge?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

conflicts

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.

Gets a ConflictCollection object that represents all the conflicts in the document.

conflicts?: Word.Interfaces.ConflictData[];

Property Value

Word.Interfaces.ConflictData[]

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

locks

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.

Gets a CoauthoringLockCollection object that represents the locks in the document.

locks?: Word.Interfaces.CoauthoringLockData[];

Property Value

Word.Interfaces.CoauthoringLockData[]

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

me

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.

Gets a Coauthor object that represents the current user.

me?: Word.Interfaces.CoauthorData;

Property Value

Word.Interfaces.CoauthorData

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

pendingUpdates

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.

Gets whether the document has pending updates that have not been accepted.

pendingUpdates?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

updates

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.

Gets a CoauthoringUpdateCollection object that represents the most recent updates that were merged into the document.

updates?: Word.Interfaces.CoauthoringUpdateData[];

Property Value

Word.Interfaces.CoauthoringUpdateData[]

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]