ONLYOFFICE Docs v7.1 开发者版: API 更新

2022年05月20日作者: Alina

伴随着新功能的发布，我们更新了编辑器、插件和文档生成器的API。继续阅读了解更多。

ONLYOFFICE Docs 7.1 for developers: API updates

WOPI操作的文件保存调整

新的请求头可用于PutFile ，以区分三种类型的文件保存：

X-LOOL-WOPI-IsModifiedByUser 表示用户在保存前是否修改了文件，或者他们只是按了保存按钮而没有做的任何修改。
X-LOOL-WOPI-IsAutosave 表示PutFile是否由自动保存或任何用户操作（如点击保存按钮或菜单条目）触发的。
X-LOOL-WOPI-IsExitSave 表示当文档从内存中被清理时，例如当所有用户断开连接时，是否会触发自动保存。

更新转换和新格式

您现在可以定义文档布局，它指定打印表单为PDF文档或图像的参数。了解更多

另一个参数，在PDF、XPS和OXPS文件转换时，允许定义文件渲染器。了解更多

此外，我们还增加了新的转换选项：

PDF 转成 DOCX，
XPS 和 OXPS 转成 DOCX，
XLSB 格式 (以及查看 XLSB 文件的功能)。

为信息显示定义用户组

通过 document.permissions.userInfoGroups 参数，您能够指定在编辑器中信息显示的用户组，包括：

头部的当前编辑用户列表中的用户名，
在输入文本时，用户光标和带有其名称的提示，
在自动的共同编辑模式下锁定对象时的用户名。

"permissions": {
  ...
  "userInfoGroups": ["Group1", ""]
  ...    },

这里 [“Group1”, “”] 意味着，来自组1的用户和不属于任何组的用户的信息显示。

拼写检查器设置

从v7.1开始，我们增加了 editorConfig.customization.features 参数部分，它允许设置用户可以禁用或自定义的参数（如可），包括拼写检查器。

editorConfig.customization.spellcheck 字段现在已经废弃了，您应该使用 editorConfig.customization.features.spellcheck 字段来定义，当加载文档或演示文稿编辑器时，拼写检查器是否自动激活或停用。

"features": {
  "spellcheck": {
  "mode": true,
  }

其他变化

现在对初始化配置签名中的参数列表进行了严格规范。
editorConfig.customization.chat 参数已被废弃，请使用 document.permissions.chat 参数代替。
用于在正文中启用令牌的 services.CoAuthoring.token.inbox.inBody 和 services.CoAuthoring.token.outbox.inBody 已被废弃。

获取ONLYOFFICE Docs的面向开发者的最新版：

立即下载

插件的API更新

在插件命令代码和宏中，窗口和文档对象以及警报功能的访问被限制。了解更多
带有OLE对象的插件的新方法： GetAllOleObjects, RemoveOleObject, RemoveOleObjects, 和 SelectOleObject。

了解如何创建插件

Document Builder的API更新

DocBuilder的API得到了很大的增强。除了生成DOCX、XLSX、PPTX和PDF文件外，您现在还可以处理可填写的表单，例如：

builder.CreateFile("docxf");
ONLYOFFICE Document Builder
var oDocument = Api.GetDocument();  
text document contents
var oTextForm = Api.CreateTextForm();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oTextForm); 
oTextForm.SetText("John Smith"); 
builder.SaveFile("docxf", "example.docxf");
format with the 'example.docxf' name
builder.CloseFile();   
ONLYOFFICE Document Builder