Word.Coauthor class

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

context: RequestContext;

プロパティ値

共同作成者のメール アドレスを取得します。

readonly emailAddress: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

Coauthor オブジェクトの一意の識別子を取得します。

readonly id: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

この作成者が現在のユーザーを表しているかどうかを取得します。

readonly isMe: boolean;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

この共同作成者に関連付けられているドキュメント内のロックを表す CoauthoringLockCollection オブジェクトを取得します。

readonly locks: Word.CoauthoringLockCollection;

プロパティ値

注釈

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

共同作成者の表示名を取得します。

readonly name: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

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

load(options?: Word.Interfaces.CoauthorLoadOptions): Word.Coauthor;

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

toJSON(): Word.Interfaces.CoauthorData;

返品

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

track(): Word.Coauthor;

返品

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

untrack(): Word.Coauthor;

返品