ONLYOFFICE 文档开发者版 8.2: API 更新

2024年10月31日作者: Mona

与 8.2 版本的新功能发布一道,我们更新了各编辑器、Office API 以及插件的 API,为文档生成器添加了 Java 框架和 PHP 集成 SDK。继续阅读,了解详情。

ONLYOFFICE Docs 8.2 for developers: API updates

停机部署

不停机部署是更新应用的一种绝佳方式,无需暂停部署即可更新应用。如此一来,对编辑器进行更新时可以不用将其暂时下线了。

工作原理是什么呢?带有新版本的 ONLYOFFICE 文档 (文档服务器,DS)实例可以与当前正在运行的文档服务器并行启动。新的编辑会话在新的 DS 中打开。旧版本的 DS 继续运行,直到用户自己完成他们的编辑会话。只有在那之后,旧的 DS 才会停止。

对于ONLYOFFICE文档的分片,我们可以将编辑会话直接定向到集群中的特定 DS。由此,不同版本的文档服务器即可并行运行。但请不要忘记将复制资源和更新过程所需时间考虑在内。

温馨提示:不停机部署的特性适用于 Kubernetes 分片部署的ONLYOFFICE 文档。想要了解更多吗?联系我们:sales@onlyoffice.com

PHP 集成 SDK

轻松集成 ONLYOFFICE 文档到您用 PHP 编写的应用程序中。该 SDK 包含了 PHP 集成的通用代码,用于创建初始化配置以及在后端处理常用方法。立即查看

例如,PHP SDK 目前已在 ONLYOFFICE  Chamilo 集成中实现。

新的界面样式

editorConfig.customization.features 参数新增了两个字段– tabStyle 和 tabBackground。您可以使用这两个参数根据自己的喜好调整编辑器的外观。

前者允许设置填充样式(顶部工具栏选项卡突出显示)或线条样式(顶部工具栏选项卡通过下划线突出显示)。

后者定义了顶部工具栏选项卡的背景色是否与顶部背景色或工具栏背景色相匹配。

ONLYOFFICE Docs 8.2 for developers: API updates

此外,我们在 editorConfig.customization.logo 参数中还添加了 imageLight 字段。该字段定义了用于浅色顶部的图像文件的路径,例如,在新添加的灰色主题中。

ONLYOFFICE Docs 8.2 for developers: API updates

const logo = {
  image: "https://example.com/logo.png",
  imageDark: "https://example.com/dark-logo.png",
  imageLight: "https://example.com/light-logo.png",
  url: "https://example.com",
  visible: true,
}

从第三方来源插入文本

setRequestedDocument 方法的 c 参数中增加了文档选择的 insert-text 类型。用户便可以从本地/URL/存储文件中选择一个文档,并将其中的内容插入到当前文档中。

docEditor.setRequestedDocument({
  c: "insert-text",
  fileType: "docx",
  url: "https://example.com/url-to-example-document.docx",
...

文档状态检查

info 命令的响应中新增了 users 参数。这个参数定义了打开文档进行编辑的用户的标识符列表。当文档被更改时,users 将返回最后编辑文档的用户的标识符。

{
  "error": 0,
  "key": "Khirz6zTPdfd7",
  "users": ["6d5a81d0", "78e1e841"]
}

文档 API 的其他变化

获取最新的 ONLYOFFICE 文档开发者版:

立即下载

邮件通知:许可证和配额限制提醒

现在您可以发送邮件通知了。例如,许可证即将到期或连接数即将达到限额的通知。

工作原理我们在服务器配置中添加了设置邮件服务器的功能。发送通知使用的是外部邮件服务器,并通过 Nodemailer 库建立连接。服务器配置中的许多设置都直接转移到了这个库中。

插件 API 改进

插件API也带来了一些有用的增强功能,特别是执行撤销(Undo)和重做(Redo)操作的方法。

  • api.prototype.Undo = function()
  • api.prototype.Redo = function()
  • api.prototype.CanUndo = function()
  • api.prototype.CanRedo = function()

查看插件 API 更新的完整列表

文档生成器的 Java 框架

ONLYOFFICE文档生成器新增一个 Java Builder 框架。它包含了一系列的库、类和函数,这些资源使得在 Java 中快速开发具有文档创建功能的应用程序更加容易。

ONLYOFFICE Docs 8.2 for developers: API updates

获取文档生成器

Office API

对于 Office JavaScript API,我们在 8.2 版本中添加了许多新方法,用途包括:

  • 范围;
  • 数据透视表;
  • 占位符;
  • 获取和替换单词/句子;
  • 更新所有字段;
  • 大纲;
  • 以及其他。

查看新方法的完整列表

创建免费的 ONLYOFFICE 账户

在线查看并协作编辑文本文档、电子表格、幻灯片、表单和 PDF 文件。