WebOffice 开放平台

主题

回到顶部
本页内容

评论(Comments)

方法列表

方法说明
GetComments()
获取评论列表
ReplyComment({ SelectionId, ReplyId, Text })
回复评论
GetCommentById({ SelectionId })
获取评论引用正文
LocateComment({ SelectionId })
定位并高亮评论区域

GetComments()

获取评论列表

语法

表达式.ActiveOutline.Comments.GetComments()

表达式：文档类型应用对象

返回值

属性数据类型说明
selection_id
String
评论选区 id
reply_comments
String
回复的评论
comment_count
Number
评论数量
comments
Object
评论内容对象

示例

js
async function example() {
  await instance.ready();

  const app = await instance.Application;
  const comments = await app.ActiveOutline.Comments;

  const GetComments = await comments.GetComments();
  console.log('GetComments: ', GetComments);
}

ReplyComment({ SelectionId, ReplyId, Text })

回复评论

需要刷新才能看到效果（非即时同步）

语法

表达式.ActiveOutline.Comments.ReplyComment({ SelectionId, ReplyId, Text })

表达式：文档类型应用对象

参数

属性数据类型默认值必填说明
SelectionId
String
否
评论选区 id
ReplyId
String
否
回复 id
Text
String
是
评论内容

返回值

回复评论成功返回 true，失败返回 false

示例

js
async function example() {
  await instance.ready()

  const app = await instance.Application;
  const comments = await app.ActiveOutline.Comments;

  const commentsList = await comments.GetComments();

  // 回复评论
  await comments.ReplyComment({
    SelectionId: commentsList[0].selection_id,
    Text: '金山文档开放平台',
  });
}

GetCommentById({ SelectionId })

获取评论引用正文

语法

表达式.ActiveOutline.Comments.GetCommentById({ SelectionId })

表达式：文档类型应用对象。

参数

属性类型默认值必填说明
SelectionId
String
否
评论选区 id

示例

js
async function example() {
  await instance.ready();

  const app = await instance.Application;
  const comments = await app.ActiveOutline.Comments;

  const commentsList = await comments.GetComments();

  // 获取评论引用正文
  await comments.GetCommentById({
    SelectionId: commentsList[0].selection_id,
  });
}

LocateComment({ SelectionId })

定位并高亮评论区域

语法

表达式.ActiveOutline.Comments.LocateComment({ SelectionId })

表达式：文档类型应用对象。

参数

属性类型默认值必填说明
SelectionId
String
否
评论选区 id

示例

js
async function example() {
  await instance.ready();

  const app = await instance.Application;
  const comments = await app.ActiveOutline.Comments;

  const commentsList = await comments.GetComments();

  // 定位并高亮评论区域
  await comments.LocateComment({
    SelectionId: commentsList[0].selection_id,
  });
}