| 作者 | 日期 |
|---|---|
| 雨中星辰 | 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-問題及排除
本文翻譯自官方文檔
