該文檔編輯服務(wù)通知文件存儲服務(wù)有關(guān)使用文檔編輯的狀態(tài)callbackUrl從的JavaScript API。該文檔編輯服務(wù)使用與身體信息的POST請求。

參數(shù)及其描述：

在版本4.2之前的ONLYOFFICE文檔服務(wù)器中驶悟，使用了帶有QueryString中的參數(shù)的GET請求。

狀態(tài)1 接收到與文檔共同編輯的每個用戶連接或斷開的連接瞭吃。

狀態(tài)2(3) 在關(guān)閉文檔進行編輯后10秒接收碌嘀，使用最后一個將更改發(fā)送到文檔編輯服務(wù)的用戶的標識符進行編輯。

狀態(tài)4 在最后一個用戶關(guān)閉文檔進行編輯而沒有更改時接收歪架。

狀態(tài)6(7) 在執(zhí)行省力請求時接收股冗。

當兩個用戶共同編輯文檔時，文檔編輯服務(wù)將JSON對象的樣本發(fā)送到“callbackUrl”地址

{
    "actions": [{"type": 1, "userid": "78e1e841"}],
    "key": "Khirz6zTPdfd7",
    "status": 1,
    "users": ["6d5a81d0", "78e1e841"]
}

當用戶更改文檔并關(guān)閉它以進行編輯時和蚪，文檔編輯服務(wù)將JSON對象的示例發(fā)送到“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"]
}

當最后一個用戶關(guān)閉文檔進行編輯而沒有更改時止状，文檔編輯服務(wù)將JSON對象的樣本發(fā)送到“callbackUrl”地址

{
    "key": "Khirz6zTPdfd7",
    "status": 4
}

收到forcedave命令后，文檔編輯服務(wù)將JSON對象的樣本發(fā)送到“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"
}

來自文檔存儲服務(wù)的響應(yīng)

的文檔存儲服務(wù)必須返回以下響應(yīng)攒霹，否則文檔編輯器將顯示一個錯誤消息：

{
    "error": 0
}

該文檔管理和文檔存儲服務(wù)都可能包含在以社區(qū)服務(wù)器或必須由誰自己的服務(wù)器上使用ONLYOFFICE文件服務(wù)器軟件集成來實現(xiàn)怯疤。

.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-協(xié)同編輯
【onlyoffice中文指南】5-轉(zhuǎn)換和下載文件
【onlyoffice中文指南】6-文檔歷史
【onlyoffice中文指南】7-安全
【onlyoffice中文指南】8-高級參數(shù)
【onlyoffice中文指南】9-回調(diào)處理程序
【onlyoffice中文指南】10-Document配置
【onlyoffice中文指南】11-編輯器(Editor)參數(shù)配置
【onlyoffice中文指南】12-問題及排除

本文翻譯自官方文檔