Word.CoauthoringLock class

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

context: RequestContext;

Eigenschaftswert

Ruft den Besitzer der Sperre ab.

readonly owner: Word.Coauthor;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

Ruft ein Range Objekt ab, das den Teil des Dokuments darstellt, der in dem CoauthoringLock Objekt enthalten ist.

readonly range: Word.Range;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.4

Ruft einen CoauthoringLockType Wert ab, der den Sperrtyp darstellt.

readonly type: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed";

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

// Gets all coauthoring locks in the document.
await Word.run(async (context) => {
  const locks: Word.CoauthoringLockCollection = context.document.coauthoring.locks;
  locks.load("items/type");
  await context.sync();

  if (locks.items.length === 0) {
    console.log("No locks found in the document.");
    return;
  }

  console.log(`Found ${locks.items.length} lock(s) in the document:`);
  for (let i = 0; i < locks.items.length; i++) {
    const lock: Word.CoauthoringLock = locks.items[i];
    console.log(`  Lock ${i + 1}: type = ${lock.type}`);
  }
});

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.CoauthoringLockLoadOptions): Word.CoauthoringLock;

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

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.CoauthoringLockUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.CoauthoringLock): void;

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

toJSON(): Word.Interfaces.CoauthoringLockData;

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

Gibt zurück

Hebt diese Sperre auf, auch wenn sie einem anderen Benutzer gehört.

unlock(): void;

Gibt zurück

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

// Removes the first coauthoring lock found in the document.
await Word.run(async (context) => {
  const locks: Word.CoauthoringLockCollection = context.document.coauthoring.locks;
  locks.load("items");
  await context.sync();

  if (locks.items.length === 0) {
    console.log("No locks found to remove.");
    return;
  }

  locks.items[0].unlock();
  await context.sync();

  console.log("First lock removed.");
});

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

Gibt zurück