Word.Coauthor class

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

context: RequestContext;

Eigenschaftswert

Ruft die E-Mail-Adresse des Mitautors ab.

readonly emailAddress: string;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

Ruft den eindeutigen Bezeichner für das Coauthor Objekt ab.

readonly id: string;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

Ruft ab, ob dieser Autor den aktuellen Benutzer vertritt.

readonly isMe: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

Ruft ein CoauthoringLockCollection Objekt ab, das die Sperren im Dokument darstellt, die diesem Co-Autor zugeordnet sind.

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-coauthors.yaml

// Gets the locks held by each coauthor in the document.
await Word.run(async (context) => {
  const authors: Word.CoauthorCollection = context.document.coauthoring.authors;
  authors.load("items/name");
  await context.sync();

  if (authors.items.length === 0) {
    console.log("No coauthors are currently editing this document.");
    return;
  }

  authors.items.forEach((author: Word.Coauthor) => {
    author.locks.load("items/type");
  });
  await context.sync();

  authors.items.forEach((author: Word.Coauthor) => {
    const lockCount = author.locks.items.length;
    if (lockCount === 0) {
      console.log(`${author.name}: no locks`);
    } else {
      const types = author.locks.items.map((l) => l.type).join(", ");
      console.log(`${author.name}: ${lockCount} lock(s) — ${types}`);
    }
  });
});

Ruft den Anzeigenamen des Mitautors ab.

readonly name: string;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

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.CoauthorLoadOptions): Word.Coauthor;

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.Coauthor;

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.Coauthor;

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.Coauthor Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.CoauthorData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Word.Interfaces.CoauthorData;

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.Coauthor;

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.Coauthor;

Gibt zurück