com.onlyoffice.model.documenteditor.config.document

Class ReferenceData

java.lang.Object

com.onlyoffice.model.documenteditor.config.document.ReferenceData

public class ReferenceData
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
private String	fileKey Defines the unique document identifier used by the service to get a link to the file.
private String	instanceId Defines the unique system identifier.
private String	key defines the unique document identifier used by the service to take the data from the co-editing session.

Constructor Summary

Constructors

Constructor and Description
ReferenceData()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

fileKey

private String fileKey

Defines the unique document identifier used by the service to get a link to the file. It must not be changed when the document is edited and saved (i.e. it is not equal to the document.key parameter).

instanceId

private String instanceId

Defines the unique system identifier. If the data was copied from a file on one system, and inserted into a file on another, then pasting by link will not be available and there will be no corresponding button in the context menu.

key

private String key

defines the unique document identifier used by the service to take the data from the co-editing session. 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.

Constructor Detail

ReferenceData

public ReferenceData()