Word.CommentDetail interface

程序包:

word

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

此注释的 ID 和回复 ID 的结构。

注解

API 集：WordApi BETA (仅预览版)

使用方

• 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 BETA (仅预览版)

replyIds

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示对此评论的回复的 ID。

replyIds: string[];

属性值

string[]

注解

API 集：WordApi BETA (仅预览版)