com.onlyoffice.model.documenteditor.config

Class Document

java.lang.Object

com.onlyoffice.model.documenteditor.config.Document

public class Document
extends Object

Defines the document parameters.

Field Summary

Fields

Modifier and Type	Field and Description
private String	fileType Defines the type of the file for the source viewed or edited document.
private Info	info Defines the additional parameters for the document.
private String	key Defines the unique document identifier used by the service to recognize the document.
private Permissions	permissions Defines the permission for the document to be edited and downloaded or not.
private ReferenceData	referenceData Defines an object that is generated by the integrator to uniquely identify a file in its system.
private String	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.
private String	url Defines the absolute URL where the source viewed or edited document is stored.

Constructor Summary

Constructors

Constructor and Description
Document()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fileType

private String fileType

Defines the type of the file for the source viewed or edited document. Must be lowercase. The available file types can be found in the Formats repository.

key

private String 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.

referenceData

private ReferenceData referenceData

Defines an object that is generated by the integrator to uniquely identify a file in its system.

title

private String 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.

url

private String 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.

info

private Info info

Defines the additional parameters for the document.

permissions

private Permissions permissions

Defines the permission for the document to be edited and downloaded or not.

Constructor Detail

Document

public Document()