Word.CoauthoringLock class

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

ロックの所有者を取得します。

readonly owner: Word.Coauthor;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

CoauthoringLock オブジェクトに含まれるドキュメントの部分を表すRange オブジェクトを取得します。

readonly range: Word.Range;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

ロックの種類を表す CoauthoringLockType 値を取得します。

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

プロパティ値

注釈

API セット: WordApiDesktop 1.4

例

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

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

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

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.CoauthoringLock): void;

パラメーター

返品

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.CoauthoringLock オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.CoauthoringLockData と型指定) を返します。

toJSON(): Word.Interfaces.CoauthoringLockData;

返品

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.CoauthoringLock;

返品

別のユーザーに属している場合でも、このロックを削除します。

unlock(): void;

返品

注釈

API セット: WordApiDesktop 1.4

この API は、レガシ共同編集ロックでのみ機能します。 ロック管理がサービスによって自動的に処理される最新の OneDrive や SharePoint の共同編集には適用されません。 モダン ドキュメントの呼び出しは、 GeneralException エラーで失敗します。

例

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

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。

untrack(): Word.CoauthoringLock;

返品