onlyoffice 回调传参数_【onlyoffice中文指南】9-回调处理程序

作者

日期

雨中星辰

2018-12-20

该文档编辑服务通知文件存储服务有关使用文档编辑的状态callbackUrl从的JavaScript API。该文档编辑服务使用与身体信息的POST请求。

参数及其描述：

在版本4.2之前的ONLYOFFICE文档服务器中，使用了带有QueryString中的参数的GET请求。

参数

描述

类型

存在

actions

如果连接到文档的新用户共同编辑或与其断开连接，则定义收到的对象。在第一种情况下，类型字段值为1，在另一种情况下为0。的用户ID字段值是谁连接到或从共同编辑文件断开的用户的标识符。

对象数组

可选的

changeshistory

使用文档更改历史记录定义对象数组。

当状态值仅等于2或3时，该对象存在。必须被发送作为一个属性的变化发送作为参数传递给该对象的refreshHistory方法。

从版本4.2开始不推荐使用，请改用历史记录。

对象数组

可选的

changesurl

使用用于跟踪和显示文档更改历史记录的文档编辑数据定义文件的链接。

当状态值仅等于2或3时，链接存在。必须保存该文件，并且必须使用setHistoryData方法将其地址作为changesUrl参数发送，以显示与特定文档版本对应的更改。

string

可选的

forcesavetype

执行强制保存请求时定义启动器的类型。可以具有以下值：

* 0 - 对命令服务执行强制保存请求，

* 1 - 每次保存时执行强制保存请求(例如，单击“ 保存”按钮)，仅当forceave选项设置为true时才可用。

* 2 - 使用服务器配置中的设置由计时器执行强制保存请求。

当状态值仅等于6或7时，存在类型。

整数

可选的

history

使用文档更改历史记录定义对象。当状态值仅等于2或3时，该对象存在。它包含对象serverVersion和变化，它们必须作为属性被发送serverVersion和变化发送作为参数传递给该对象的refreshHistory方法。

对象

可选的

key

定义编辑的文档标识符。

字符串

需要

status

定义文档的状态。可以具有以下值：

* 0 - 找不到带有密钥标识符的文档，

* 1 - 正在编辑文档，

* 2 - 文件已准备好保存，

* 3 - 发生了文档保存错误，

* 4 - 文件关闭，没有变化，

* 6 - 正在编辑文档，但保存当前文档状态，

* 7 - 强制保存文档时发生错误。

整数

需要

url

定义要与文档存储服务一起保存的已编辑文档的链接。

当状态值仅等于2或3时，链接存在。

字符串

可选的

userdata

定义发送到命令服务的自定义信息，以防它出现在请求中。

字