处理评论
使用自动化 API 从外部 UI 管理文档评论 — 添加、删除、回复和导航,无需直接操作编辑器。
信息
文档打开时包含现有评论。您的代码调用 connector.executeMethod() 和 connector.attachEvent() 来与评论交互。编辑器会实时更新。
COMMENTS (0)
它是如何运作的
-
当用户打开文档时,会执行 GetAllComments 方法来收集文档中的所有评论,并将其显示在自定义界面中。将显示以下评论数据:评论作者、发布评论的时间、评论文本和评论回复:
let comments = [];const onDocumentReady = () => {window.connector = docEditor.createConnector();connector.executeMethod("GetAllComments", null, (data) => {comments = data;});}; -
当用户单击自定义界面中的 添加评论 按钮时,将执行 AddComment 方法向文档添加新评论。调用此方法后,会触发 onAddComment 事件,将新评论添加到包含所有文档评论的数组中:
const onDocumentReady = () => {connector.attachEvent("onAddComment", (val) => {const index = comments.findIndex((comment) => comment["Id"] === val["Id"]);if (index === -1) {comments.unshift(val);}});};document.getElementById("addComment").addEventListener("click", () => {const comment = document.getElementById("addCommentArea").value;if (comment) {const datetime = `${Date.now()}`;connector.executeMethod("AddComment", [{Text: comment,UserName: "John Smith",Time: datetime,}]);}}); -
当用户单击自定义界面中的 删除 按钮时,将执行 RemoveComments 方法从文档中删除评论。调用此方法后,将触发 onRemoveComment 事件,以从包含所有文档评论的数组中删除评论:
const onDocumentReady = () => {connector.attachEvent("onRemoveComment", (val) => {const index = comments.findIndex((comment) => comment["Id"] === val["Id"]);if (index !== -1) {comments.splice(index, 1);}});};document.getElementById("deleteComment").addEventListener("click", () => {connector.executeMethod("RemoveComments", [[comments[indexComment]["Id"]]]);}); -
当用户单击自定义界面中的 上一个/下一个 按钮时,将执行 MoveToComment 方法在文档中的评论之间导航:
connector.executeMethod("MoveToComment", [comments[indexComment]["Id"]]); -
当用户单击自定义界面中的 添加回复 按钮时,将执行 ChangeComment 方法,通过更改 CommentData 对象向现有评论添加回复。调用此方法后,会触发 onChangeCommentData 事件,将新的评论回复添加到包含所有文档评论的数组中:
const onDocumentReady = () => {connector.attachEvent("onChangeCommentData", (val) => {const index = comments.findIndex((comment) => comment["Id"] === val["Id"]);if (index !== -1) {comments[index]["Data"] = val["Data"];}});};document.getElementById("addReply").addEventListener("click", () => {const reply = document.getElementById("addReplyArea").value;if (reply) {const datetime = `${Date.now()}`;comments[indexComment]["Data"]["Replies"].push({Text: reply,Time: datetime,UserName: "John Smith",});connector.executeMethod("ChangeComment",[comments[indexComment]["Id"],comments[indexComment]["Data"]],);}});
备注
请注意,该连接器仅适用于 ONLYOFFICE 文档开发者版本.
此类是一项附加功能,默认情况下不包含在ONLYOFFICE文档开发者版中,需要额外付费。 如果您有任何疑问,请通过 sales@onlyoffice.com联系我们的销售团队。