Word.Coauthoring class

Ruft ein CoauthorCollection Objekt ab, das alle Mitautoren darstellt, die das Dokument derzeit bearbeiten.

readonly authors: Word.CoauthorCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

Ruft ab, ob dieses Dokument gemeinsam erstellt werden kann.

readonly canCoauthor: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

Ruft ab, ob das Dokument automatisch zusammengeführt werden kann.

readonly canMerge: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

Ruft ein ConflictCollection Objekt ab, das alle Konflikte im Dokument darstellt.

readonly conflicts: Word.ConflictCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

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}`);
  }
});

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Ruft ein CoauthoringLockCollection Objekt ab, das die Sperren im Dokument darstellt.

readonly locks: Word.CoauthoringLockCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

Diese API funktioniert nur mit älteren Sperren für die gemeinsame Dokumenterstellung. Sie gilt nicht für moderne OneDrive- oder SharePoint-Co-Authoring, wo die Sperrverwaltung automatisch vom Dienst übernommen wird. Aufrufe eines modernen Dokuments schlagen mit einem GeneralException Fehler fehl.

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.");
});

Ruft ein Coauthor Objekt ab, das den aktuellen Benutzer darstellt.

readonly me: Word.Coauthor;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

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);
});

Ruft ab, ob das Dokument ausstehende Aktualisierungen enthält, die nicht akzeptiert wurden.

readonly pendingUpdates: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

Ruft ein CoauthoringUpdateCollection Objekt ab, das die letzten Updates darstellt, die mit dem Dokument zusammengeführt wurden.

readonly updates: Word.CoauthoringUpdateCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

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}"`);
  });
});

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

Ü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 sie übergeben wird.) Während das ursprüngliche Word.Coauthoring Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.CoauthoringData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Word.Interfaces.CoauthoringData;

Gibt zurück

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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.

track(): Word.Coauthoring;

Gibt zurück

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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.Coauthoring;

Gibt zurück