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
Defines the type of the file for the source viewed or edited document. Must be lowercase. string "docx"
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"
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"
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",
        "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.

The key characters can be used: 0-9, a-z, A-Z, -._=. The maximal key length is 20 characters.