Callback handler
文档编辑服务使用JavaScript API的回调url通知文档存储服务文档编辑的状态。文档编辑服务使用带有正文信息的POST请求。
参数说明
| 参数 | 描述 | 类型 | 样例 |
|---|---|---|---|
| actions | 定义新用户连接到文档协同编辑或断开与文档的连接时接收的对象。在第一种情况下，“类型”字段值为1，在另一种情况下为-0。userid字段值是连接到文档协同编辑或从文档协同编辑断开连接的用户的标识符。 | array of object | optional |
| changeshistory | 定义具有文档更改历史记录的对象数组。仅当状态值等于2或3时，对象才存在。必须将对象的属性更改作为参数发送到refreshHistory方法。 | array of object | optional |
| changesurl | 使用用于跟踪和显示文档更改历史记录的文档编辑数据定义到文件的链接。当状态值仅等于2或3时，链接存在。必须保存文件，并且必须使用setHistoryData方法将其地址作为changesUrl参数发送，以显示与特定文档版本相对应的更改。 | string | optional |
| forcesavetype | 定义执行强制保存请求时启动器的类型。可以具有以下值：0-对命令服务执行强制保存请求，1-每次保存完成时（例如单击“保存”按钮）都会执行强制保存请求，仅当forcesave选项设置为true时才可用。2-强制保存请求由定时器使用服务器配置中的设置执行。 | integer | optional |
| history | 定义具有文档更改历史记录的对象。仅当状态值等于2或3时，对象才存在。它包含对象更改和serverVersion，必须作为refreshHistory方法的参数发送对象的属性更改和serverVersion。 | object | optional |
| key | 定义编辑的文档标识符。 | string | required |
| status | 定义文档的状态。可以具有以下值：1-正在编辑文档，2-文档已准备好保存，3-发生文档保存错误，4-文档已关闭，没有更改，6-正在编辑文档，但当前文档状态已保存，7-强制保存文档时出错。 | integer | required |
| url | 定义指向要与文档存储服务一起保存的已编辑文档的链接。当状态值仅等于2或3时，链接存在。 | string | optional |
| userdata | 定义发送到命令服务的自定义信息，以防它出现在请求中。 | string | optional |
| users | 定义打开文档进行编辑的用户的标识符列表；更改文档后，用户将返回最后一个编辑文档的用户的标识符（对于状态2和状态6答复）。 | array of string | optional |
当两个用户共同编辑文档时，文档编辑服务将JSON对象发送到“callbackUrl”地址的示例
{
"actions": [{"type": 1, "userid": "78e1e841"}],
"key": "Khirz6zTPdfd7",
"status": 1,
"users": ["6d5a81d0", "78e1e841"]
}
当用户更改文档并关闭文档进行编辑时，文档编辑服务将JSON对象发送到“callbackUrl”地址的示例
{
"actions": [{"type": 0, "userid": "78e1e841"}],
"changesurl": "https://documentserver/url-to-changes.zip",
"history": {
"changes": changes,
"serverVersion": serverVersion
},
"key": "Khirz6zTPdfd7",
"status": 2,
"url": "https://documentserver/url-to-edited-document.docx",
"users": ["6d5a81d0"]
}
当最后一个用户关闭文档进行编辑时，文档编辑服务将JSON对象的示例发送到“callbackUrl”地址，但未做任何更改
{
"key": "Khirz6zTPdfd7",
"status": 4
}
接收到forcesave命令后，文档编辑服务将JSON对象的示例发送到“callbackUrl”地址
{
"changesurl": "https://documentserver/url-to-changes.zip",
"forcesavetype": 0,
"history": {
"changes": changes,
"serverVersion": serverVersion
},
"key": "Khirz6zTPdfd7",
"status": 6,
"url": "https://documentserver/url-to-edited-document.docx",
"users": ["6d5a81d0"],
"userdata": "sample userdata"
}
文档存储服务必须返回以下响应，否则文档编辑器将显示错误消息：
{
"error": 0
}