Document
Description
The document section allows to change all the parameters pertaining to the document (title, url, file type, etc.).
Parameters
Name | Description | Type | Example |
fileType | Defines the type of the file for the source viewed or edited document. Must be lowercase. The following file types are available: .csv, .djvu, .doc, .docm, .docx, .docxf, .dot, .dotm, .dotx, .epub, .fb2, .fodp, .fods, .fodt, .htm, .html, .mht, .odp, .ods, .odt, .oform, .otp, .ots, .ott, .oxps, .pdf, .pot, .potm, .potx, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf, .txt, .xls, .xlsb, .xlsm, .xlsx, .xlt, .xltm, .xltx, .xml, .xps. | string | “docx” |
key | Defines the unique document identifier used by the service to recognize the document. In case the known key is sent the document will be taken from the cache. Every time the document is edited and saved, the key must be generated anew. The document url can be used as the key but without the special characters and the length is limited to 128 symbols. | string | “Khirz6zTPdfd7” |
The key characters can be used: 0-9, a-z, A-Z, -._=. The maximal key length is 20 characters. | |||
referenceData | Defines an object that is generated by the integrator to uniquely identify a file in its system:
| object | |
title | Defines the desired file name for the viewed or edited document which will also be used as file name when the document is downloaded. The length is limited to 128 symbols. | string | “Example Document Title.docx” |
url | Defines the absolute URL where the source viewed or edited document is stored. Be sure to add a token when using local links. Otherwise, an error will occur. | string | “https://example.com/url-to-example-document.docx“ |
* - required field
Example
var docEditor = new DocsAPI.DocEditor("placeholder", {
"document": {
"fileType": "docx",
"key": "Khirz6zTPdfd7",
"referenceData": {
"fileKey": "BCFA2CED",
"instanceId": "https://example.com"
},
"title": "Example Document Title.docx",
"url": "https://example.com/url-to-example-document.docx",
},
...
});
Where the example.com is the name of the server where document manager and document storage service are installed. See the How it works section to find out more on Document Server service client-server interactions.
当前内容版权归 Onlyoffice 或其关联方所有,如需对内容或内容相关联开源项目进行关注与资助,请访问 Onlyoffice .