【onlyoffice中文指南】9-回调处理程序
2018-12-19 本文已影响0人
雨中星辰0
| 作者 | 日期 |
|---|---|
| 雨中星辰 | 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 | 定义发送到命令服务的自定义信息，以防它出现在请求中。 | 字符串 | 可选的 |
| users | 定义打开文档进行编辑的用户的标识符列表; 当文档被更改时，用户将返回最后一个编辑文档的用户的标识符（状态2和状态6回复）。 |
字符串数组 | 可选的 |
状态1 接收到与文档共同编辑的每个用户连接或断开的连接。
状态2(3) 在关闭文档进行编辑后10秒接收，使用最后一个将更改发送到文档编辑服务的用户的标识符进行编辑。
状态4 在最后一个用户关闭文档进行编辑而没有更改时接收。
状态6(7) 在执行省力请求时接收。
当两个用户共同编辑文档时，文档编辑服务将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
}
收到forcedave命令后，文档编辑服务将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
}
该文档管理和文档存储服务都可能包含在以社区服务器或必须由谁自己的服务器上使用ONLYOFFICE文件服务器软件集成来实现。
.Net（C＃）文档保存示例
public class WebEditor : IHttpHandler
{
public void ProcessRequest(HttpContext context)
{
string body;
using (var reader = new StreamReader(context.Request.InputStream))
body = reader.ReadToEnd();
var fileData = new JavaScriptSerializer().Deserialize<Dictionary<string, object>>(body);
if ((int) fileData["status"] == 2)
{
var req = WebRequest.Create((string) fileData["url"]);
using (var stream = req.GetResponse().GetResponseStream())
using (var fs = File.Open(PATH_FOR_SAVE, FileMode.Create))
{
var buffer = new byte[4096];
int readed;
while ((readed = stream.Read(buffer, 0, 4096)) != 0)
fs.Write(buffer, 0, readed);
}
}
context.Response.Write("{\"error\":0}");
}
}
PATH_FOR_SAVE是计算机文件夹的绝对路径，其中将保存文件，包括文件名。
Java文档保存示例
public class IndexServlet extends HttpServlet {
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
PrintWriter writer = response.getWriter();
Scanner scanner = new Scanner(request.getInputStream()).useDelimiter("\\A");
String body = scanner.hasNext() ? scanner.next() : "";
JSONObject jsonObj = (JSONObject) new JSONParser().parse(body);
if((long) jsonObj.get("status") == 2)
{
String downloadUri = (String) jsonObj.get("url");
URL url = new URL(downloadUri);
java.net.HttpURLConnection connection = (java.net.HttpURLConnection) url.openConnection();
InputStream stream = connection.getInputStream();
File savedFile = new File(pathForSave);
try (FileOutputStream out = new FileOutputStream(savedFile)) {
int read;
final byte[] bytes = new byte[1024];
while ((read = stream.read(bytes)) != -1) {
out.write(bytes, 0, read);
}
out.flush();
}
connection.disconnect();
}
writer.write("{\"error\":0}");
}
}
Node.js文档保存示例
var fs = require("fs");
app.post("/track", function (req, res) {
var updateFile = function (response, body, path) {
if (body.status == 2)
{
var file = syncRequest("GET", body.url);
fs.writeFileSync(path, file.getBody());
}
response.write("{\"error\":0}");
response.end();
}
var readbody = function (request, response, path) {
var content = "";
request.on("data", function (data) {
content += data;
});
request.on("end", function () {
var body = JSON.parse(content);
updateFile(response, body, path);
});
}
if (req.body.hasOwnProperty("status")) {
updateFile(res, req.body, pathForSave);
} else {
readbody(req, res, pathForSave)
}
});
pathForSave是计算机文件夹的绝对路径，其中将保存文件，包括文件名。
PHP文档保存示例
<?php
if (($body_stream = file_get_contents("php://input"))===FALSE){
echo "Bad Request";
}
$data = json_decode($body_stream, TRUE);
if ($data["status"] == 2){
$downloadUri = $data["url"];
if (($new_data = file_get_contents($downloadUri))===FALSE){
echo "Bad Response";
} else {
file_put_contents($path_for_save, $new_data, LOCK_EX);
}
}
echo "{\"error\":0}";
?>
$ path_for_save是计算机文件夹的绝对路径，其中将保存文件，包括文件名。
Ruby文档保存示例
class ApplicationController < ActionController::Base
def index
body = request.body.read
file_data = JSON.parse(body)
status = file_data["status"].to_i
if status == 2
download_uri = file_data["url"]
uri = URI.parse(download_uri)
http = Net::HTTP.new(uri.host, uri.port)
if download_uri.start_with?("https")
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
end
req = Net::HTTP::Get.new(uri.request_uri)
res = http.request(req)
data = res.body
File.open(path_for_save, "wb") do |file|
file.write(data)
end
end
render :text => "{\"error\":0}"
end
end
path_for_save是计算机文件夹的绝对路径，其中将保存文件，包括文件名。
onlyoffice中文指南 目录
【onlyoffice中文指南】0-基本概念
【onlyoffice中文指南】1-onlyoffice的工作原理
【onlyoffice中文指南】2-打开文件
【onlyoffice中文指南】3-保存文件
【onlyoffice中文指南】4-协同编辑
【onlyoffice中文指南】5-转换和下载文件
【onlyoffice中文指南】6-文档历史
【onlyoffice中文指南】7-安全
【onlyoffice中文指南】8-高级参数
【onlyoffice中文指南】9-回调处理程序
【onlyoffice中文指南】10-Document配置
【onlyoffice中文指南】11-编辑器(Editor)参数配置
【onlyoffice中文指南】12-问题及排除
本文翻译自官方文档
