Word.Interfaces.CoauthoringData interface
An interface describing the data returned by calling coauthoring.toJSON().
Properties
| authors | Gets a |
| can |
Gets whether this document can be coauthored. |
| can |
Gets whether the document can be automatically merged. |
| conflicts | Gets a |
| locks | Gets a |
| me | Gets a |
| pending |
Gets whether the document has pending updates that have not been accepted. |
| updates | Gets a |
Property Details
authors
Gets a CoauthorCollection object that represents all the coauthors currently editing the document.
authors?: Word.Interfaces.CoauthorData[];Property Value
Remarks
canCoauthor
Gets whether this document can be coauthored.
canCoauthor?: boolean;Property Value
boolean
Remarks
canMerge
Gets whether the document can be automatically merged.
canMerge?: boolean;Property Value
boolean
Remarks
conflicts
Gets a ConflictCollection object that represents all the conflicts in the document.
conflicts?: Word.Interfaces.ConflictData[];Property Value
Remarks
locks
Gets a CoauthoringLockCollection object that represents the locks in the document.
locks?: Word.Interfaces.CoauthoringLockData[];Property Value
Remarks
This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a GeneralException error.
me
Gets a Coauthor object that represents the current user.
me?: Word.Interfaces.CoauthorData;Property Value
Remarks
pendingUpdates
Gets whether the document has pending updates that have not been accepted.
pendingUpdates?: boolean;Property Value
boolean
Remarks
updates
Gets a CoauthoringUpdateCollection object that represents the most recent updates that were merged into the document.
updates?: Word.Interfaces.CoauthoringUpdateData[];