com.onlyoffice.model.documenteditor

Class Callback

java.lang.Object

com.onlyoffice.model.documenteditor.Callback

public class Callback
extends Object

Defines the callback handler parameters.

Field Summary

Fields

Modifier and Type	Field and Description
private List<Action>	actions Defines the object received when the user takes an action with the document.
private String	changesurl Defines the link to the file with the document editing data used to track and display the document changes history.
private String	filetype Defines an extension of the document that is downloaded from the link specified with the url parameter.
private ForcesaveType	forcesavetype Defines the type of initiator when the force saving request is performed.
private String	formsdataurl Defines the URL to the JSON file with the submitted form data.
private History	history Defines the object with the document changes history.
private String	key Defines the edited document identifier.
private Status	status Defines the status of the document.
private String	token Defines the encrypted signature in the form of a token.
private String	url Defines the link to the edited document to be saved with the document storage service.
private List<String>	users Defines a list of the identifiers of the users who opened the document for editing.

Constructor Summary

Constructors

Constructor and Description
Callback()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

actions

private List<Action> actions

Defines the object received when the user takes an action with the document.

changesurl

private String changesurl

Defines the link to the file with the document editing data used to track and display the document changes history. The link is present when the Status value is equal to 2 or 3 only. The file must be saved and its address must be sent as "changesUrl" parameter using the "setHistoryData" method to show the changes corresponding to the specific document version.

See Also:

"setHistoryData" method in API ONLYOFFICE

filetype

private String filetype

Defines an extension of the document that is downloaded from the link specified with the url parameter. The file type is OOXML by default but if the "assemblyFormatAsOrigin" server setting is enabled, the file will be saved in its original format.

See Also:

"assemblyFormatAsOrigin" server setting in API ONLYOFFICE

forcesavetype

private ForcesaveType forcesavetype

Defines the type of initiator when the force saving request is performed. The type is present when the Status value is equal to 6 or 7 only.

formsdataurl

private String formsdataurl

Defines the URL to the JSON file with the submitted form data.

history

private History history

Defines the object with the document changes history. The object is present when the Status value is equal to 2 or 3 only. It contains the object "changes" and "serverVersion", which must be sent as properties "changes" and "serverVersion" of the object sent as the argument to the "refreshHistory" method.

See Also:

"refreshHistory" method in API ONLYOFFICE

key

private String key

Defines the edited document identifier.

status

private Status status

Defines the status of the document.

url

private String url

Defines the link to the edited document to be saved with the document storage service. The link is present when the Status value is equal to 2, 3, 6 or 7 only.

users

private List<String> users

Defines a list of the identifiers of the users who opened the document for editing. When the document has been changed, the "users" will return the identifier of the user who was the last to edit the document (for responses with the Status value equal to 2 or 6).

token

private String token

Defines the encrypted signature in the form of a token.

Constructor Detail

Callback

public Callback()