Word.Coauthoring class
Stellt das Coauthoring -Objekt dar. Dadurch werden die Aktualisierungen, Änderungen, Konflikte und andere Interaktionen im Dokument durch die gemeinsame Dokumenterstellung nachverfolgt.
- Extends
Hinweise
Verwendet von
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthors.yaml
// Gets the coauthoring capabilities and pending-update status of the document.
await Word.run(async (context) => {
const coauthoring: Word.Coauthoring = context.document.coauthoring;
coauthoring.load("canCoauthor,canMerge,pendingUpdates");
await context.sync();
console.log("Can coauthor:", coauthoring.canCoauthor);
console.log("Can merge:", coauthoring.canMerge);
console.log("Pending updates:", coauthoring.pendingUpdates);
});
Eigenschaften
| authors | Ruft ein |
| can |
Ruft ab, ob dieses Dokument gemeinsam erstellt werden kann. |
| can |
Ruft ab, ob das Dokument automatisch zusammengeführt werden kann. |
| conflicts | Ruft ein |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| locks | Ruft ein |
| me | Ruft ein |
| pending |
Ruft ab, ob das Dokument über ausstehende Updates verfügt, die nicht akzeptiert wurden. |
| updates | Ruft ein |
Methoden
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen |
Details zur Eigenschaft
authors
Ruft ein CoauthorCollection -Objekt ab, das alle Mitautoren darstellt, die derzeit das Dokument bearbeiten.
readonly authors: Word.CoauthorCollection;Eigenschaftswert
Hinweise
canCoauthor
Ruft ab, ob dieses Dokument gemeinsam erstellt werden kann.
readonly canCoauthor: boolean;Eigenschaftswert
boolean
Hinweise
canMerge
Ruft ab, ob das Dokument automatisch zusammengeführt werden kann.
readonly canMerge: boolean;Eigenschaftswert
boolean
Hinweise
conflicts
Ruft ein ConflictCollection -Objekt ab, das alle Konflikte im Dokument darstellt.
readonly conflicts: Word.ConflictCollection;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthoring-conflicts.yaml
// Gets all coauthoring conflicts in the document.
await Word.run(async (context) => {
const conflicts: Word.ConflictCollection = context.document.coauthoring.conflicts;
conflicts.load("items/type");
await context.sync();
if (conflicts.items.length === 0) {
console.log("No conflicts found in the document.");
return;
}
console.log(`Found ${conflicts.items.length} conflict(s):`);
for (let i = 0; i < conflicts.items.length; i++) {
console.log(` Conflict ${i + 1}: type = ${conflicts.items[i].type}`);
}
});
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
locks
Ruft ein CoauthoringLockCollection -Objekt ab, das die Sperren im Dokument darstellt.
readonly locks: Word.CoauthoringLockCollection;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthoring-locks.yaml
// Adds a lock to the paragraph at the insertion point.
// Requires the document to be saved to OneDrive or SharePoint.
await Word.run(async (context) => {
const coauthoring: Word.Coauthoring = context.document.coauthoring;
coauthoring.load("canCoauthor");
await context.sync();
if (!coauthoring.canCoauthor) {
console.warn("This document doesn't support coauthoring. Save it to OneDrive or SharePoint and try again.");
return;
}
const locks: Word.CoauthoringLockCollection = coauthoring.locks;
locks.add();
await context.sync();
console.log("Lock added.");
});
me
Ruft ein Coauthor -Objekt ab, das den aktuellen Benutzer darstellt.
readonly me: Word.Coauthor;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthors.yaml
// Gets the current user's coauthor information.
await Word.run(async (context) => {
const me: Word.Coauthor = context.document.coauthoring.me;
me.load("name,emailAddress,id");
await context.sync();
console.log("Current user:", me.name);
console.log("Email:", me.emailAddress);
console.log("ID:", me.id);
});
pendingUpdates
Ruft ab, ob das Dokument über ausstehende Updates verfügt, die nicht akzeptiert wurden.
readonly pendingUpdates: boolean;Eigenschaftswert
boolean
Hinweise
updates
Ruft ein CoauthoringUpdateCollection -Objekt ab, das die letzten Aktualisierungen darstellt, die mit dem Dokument zusammengeführt wurden.
readonly updates: Word.CoauthoringUpdateCollection;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/get-coauthoring-updates.yaml
// Gets the ranges affected by the most recent coauthoring updates merged into the document.
await Word.run(async (context) => {
const updates: Word.CoauthoringUpdateCollection = context.document.coauthoring.updates;
updates.load("items/range");
await context.sync();
if (updates.items.length === 0) {
console.log("No recent coauthoring updates found.");
return;
}
console.log(`Found ${updates.items.length} recent update(s).`);
const ranges = updates.items.map((u) => u.range);
ranges.forEach((r) => r.load("text"));
await context.sync();
ranges.forEach((range, i) => {
console.log(` Update ${i + 1}: "${range.text}"`);
});
});
Details zur Methode
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Word.Interfaces.CoauthoringLoadOptions): Word.Coauthoring;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Word.Coauthoring;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Coauthoring;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Word.Coauthoring Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.CoauthoringData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.CoauthoringData;Gibt zurück
track()
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
track(): Word.Coauthoring;Gibt zurück
untrack()
Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.Coauthoring;