Word.CommentDetail interface

パッケージ:

word

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

このコメントの ID と応答 ID の構造体。

注釈

API セット: WordApi ベータ版 (プレビューのみ)

使用元

• Word.CommentEventArgs: commentDetails

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/comment-events.yaml

async function onEventHandler(event: Word.CommentEventArgs) {
    // Report the event source and the IDs of affected comments and replies.
    const remoteSource: Word.EventSource = Word.EventSource.remote;
    console.log(`${event.type} event. Source: ${event.source}.`);
    if (event.source === remoteSource) {
        console.log("A coauthor triggered this event.");
    }
    event.commentDetails.forEach((comment: Word.CommentDetail) => {
        console.log("Affected comment:", { id: comment.id, replyIds: comment.replyIds });
    });
}

プロパティ

id	このコメントの ID を表します。
replyIds	このコメントに対する返信の ID を表します。

プロパティの詳細

id

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

このコメントの ID を表します。

id: string;

プロパティ値

string

注釈

API セット: WordApi ベータ版 (プレビューのみ)

replyIds

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

このコメントに対する返信の ID を表します。

replyIds: string[];

プロパティ値

string[]

注釈

API セット: WordApi ベータ版 (プレビューのみ)