Word.Coauthoring class
Represents the Coauthoring object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring.
- Extends
Remarks
Properties
| authors | Gets a |
| can |
Gets whether this document can be coauthored. |
| can |
Gets whether the document can be automatically merged. |
| conflicts | Gets a |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| locks | Gets a |
| me | Gets a |
| pending |
Gets whether the document has pending updates that have not been accepted. |
| updates | Gets a |
Methods
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
authors
Gets a CoauthorCollection object that represents all the coauthors currently editing the document.
readonly authors: Word.CoauthorCollection;Property Value
Remarks
canCoauthor
Gets whether this document can be coauthored.
readonly canCoauthor: boolean;Property Value
boolean
Remarks
canMerge
Gets whether the document can be automatically merged.
readonly canMerge: boolean;Property Value
boolean
Remarks
conflicts
Gets a ConflictCollection object that represents all the conflicts in the document.
readonly conflicts: Word.ConflictCollection;Property Value
Remarks
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
locks
Gets a CoauthoringLockCollection object that represents the locks in the document.
readonly locks: Word.CoauthoringLockCollection;Property Value
Remarks
me
Gets a Coauthor object that represents the current user.
readonly me: Word.Coauthor;Property Value
Remarks
pendingUpdates
Gets whether the document has pending updates that have not been accepted.
readonly pendingUpdates: boolean;Property Value
boolean
Remarks
updates
Gets a CoauthoringUpdateCollection object that represents the most recent updates that were merged into the document.
readonly updates: Word.CoauthoringUpdateCollection;Property Value
Remarks
Method Details
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.CoauthoringLoadOptions): Word.Coauthoring;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Word.Coauthoring;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Coauthoring;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.Coauthoring object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.CoauthoringData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.CoauthoringData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.Coauthoring;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.Coauthoring;