Word.CoauthoringLock class

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient le propriétaire de la serrure.

readonly owner: Word.Coauthor;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient un Range objet qui représente la partie du document contenue dans l’objet CoauthoringLock .

readonly range: Word.Range;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient une CoauthoringLockType valeur qui représente le type de verrou.

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

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Exemples

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

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.CoauthoringLockLoadOptions): Word.CoauthoringLock;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.CoauthoringLock;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.CoauthoringLock;

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.CoauthoringLock): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.CoauthoringLock est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.CoauthoringLockDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.CoauthoringLockData;

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.CoauthoringLock;

Retours

Supprime ce verrou, même s’il appartient à un autre utilisateur.

unlock(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Cette API fonctionne uniquement avec les verrous de co-création hérités. Elle ne s’applique pas à la co-création moderne de OneDrive ou de SharePoint, où la gestion des verrous est gérée automatiquement par le service. Les appels sur un document moderne échouent avec une GeneralException erreur.

Exemples

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

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): Word.CoauthoringLock;

Retours