ONLYOFFICE 文档高级 API：如何将所有文档的批注流集于一处管理

在本文中，您可以了解如何使用 API 生成包含文档批注的流，以便能用您自己的按钮/方法（而不是编辑器按钮）在批注间导航、回复及关闭批注。

简要介绍

使用新推出的连接器 API 类，您可以自外部与文本文档、电子表格、演示文稿和可填写的表单进行交互。

这样，您可以创建一个特别的连接器，将您的自定义界面直接链接到文档，并在其中执行任意操作。

可能的场景和案例包括：

• 将所有文档的批注流集于一处管理；
• 使用从数据库导出的数据自动填写表单；
• 从外部管理审查过程（接受/拒绝修改建议）；
• 等等。

如何开始

连接器 API 类包含在高级 API 中，受版本 7.2 开始的 ONLYOFFICE 文档开发者的新版本支持。

所以，您首先需要获取包含此选项的 ONLYOFFICE 文档开发者版 的新许可（在“访问 API”部分选择“高级”选项）。

购买许可

如果您想先试用，您可以新开始一个 ONLYOFFICE 文档开发者版 30 天试用期，或发送邮件至 sales@onlyoffice.com，联系我们的销售团队请求演示。我们也欢迎您直接联系专属的销售经理。

立即下载

您需要执行的操作

如要实现一个批注流，并使用您自己的按钮/方式处理批注，您需要创建连接器。为此，请使用文档编辑器对象的 createConnector 方法：

var connector = docEditor.createConnector()

以下是连接器所支持的、最重要几个的方法：

• attachEvent，允许您添加以前仅通过插件支持的事件侦听器。您可在此处查看完整列表。其中，您会发现一些事件，诸如更改内容控件 (onChangeContentControl) 或点击元素 (onClick)。
• callCommand，允许执行“文档构建器”脚本，以构建和修改文档。构建器文档脚本提供了超过 1,500 种方法，均可在连接器中执行。您可在此处查看文档、电子表格和演示文稿的方法列表。
• executeMethod， 允许使用连接器执行特定的编辑器方法。这些方法执行一组复杂的文档生成器命令。与纯粹的文档生成器命令不同的是，它们与编辑器中的焦点位置相关联。例如， GetSelectedText 方法允许检索所选内容，而 MoveToComment 方法将焦点移到批注。

实施方法分步说明

您可以执行这些操作、运行指定的命令，以在文档外部的某个位置管理批注。

获取您文档中的所有批注：

connector.executeMethod("GetAllComments", null, function(comments) { /**/ })

在光标突出显示的元素处添加新注释：

connector.executeMethod("AddComment",[{Text: comment, UserName: userName, Time: datetime}]);

修改任意现有的批注：

connector.executeMethod("ChangeComment", [commentId, newData]);

删除任意现有的批注：

connector.executeMethod("RemoveComments", [commentId]);

订阅更改批注的事件：

connector.attachEvent("onChangeCommentData",  function (data) { /**/ })

订阅添加批注的事件：

connector.attachEvent("onAddComment",  function (comment) { /**/ })

订阅删除批注的事件：

connector.attachEvent("onRemoveComment",  function (data) { /**/ })

这个例子表明，新的高级 API 提供了多种功能，让您可以通过程序代码更改和控制文档。

我们会不断扩展可用方法和事件的列表。不过，如果您有特定的任务或请求，但找不到合适的记录方法，请告知我们。您可以直接联系您的专属支持或销售经理，或发送邮件至sales@onlyoffice.com联系我们。

观看我们关于 API 更新的网络研讨会，详细了解面向开发者的最新增强特性：