com.onlyoffice.model.commandservice

Class CommandResponse

java.lang.Object

com.onlyoffice.model.commandservice.CommandResponse

public class CommandResponse
extends Object

Defines the response parameters that are received from the document command service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandResponse.Error Defines the Command Service error codes.

Field Summary

Fields

Modifier and Type	Field and Description
private CommandResponse.Error	error Defines an error code.
private String	key Defines the document identifier used to unambiguously identify the document file.
private List<String>	keys Defines the document identifiers used to unambiguously identify the document file.
private org.json.JSONObject	license Defines the document license information: "end_date" - the license expiration date, "trial" - defines if the license is trial or not, "customization" - defines if the customization parameters marked with the * sign are available for editing only in ONLYOFFICE Developer Edition or not, "connections" - the number of connections for the connection license, "connections_view" - the number of connections for the live viewer, "users_count" - the number of users for the user license, "users_view_count" - the number of users for the live viewer, "users_expire" - the number of days after which the user license expires.
private org.json.JSONObject	quota Defines the user quota value: "users" - the user quota for the user license where "userid" - the id of the user who opened the editor, "expire" - date of license expiration for this user; "users_view" - the user quota for the live viewer where "userid" - the id of the user who opened the editor, "expire" - date of viewing expiration for this user.
private org.json.JSONObject	server Defines the server characteristics: "resultType" - the license status (1 - an error occurred, 2 - the license expired, 3 - the license is still available, 6 - the trial license expired), "packageType" - the product version (0 - an open source product, 1 - the Enterprise Edition, 2 - the Developer Edition), "buildDate" - the build date, "buildVersion" - the build version, "buildNumber" - the build number.
private String	url Defines the link to the edited document to be saved with the document storage service.
private List<String>	users Defines the list of the identifiers of the users who opened the document for editing.
private String	version Defines the document version.

Constructor Summary

Constructors

Constructor and Description
CommandResponse()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

error

private CommandResponse.Error error

Defines an error code.

key

private String key

Defines the document identifier used to unambiguously identify the document file.

keys

private List<String> keys

Defines the document identifiers used to unambiguously identify the document file.

license

private org.json.JSONObject license

Defines the document license information: "end_date" - the license expiration date, "trial" - defines if the license is trial or not, "customization" - defines if the customization parameters marked with the * sign are available for editing only in ONLYOFFICE Developer Edition or not, "connections" - the number of connections for the connection license, "connections_view" - the number of connections for the live viewer, "users_count" - the number of users for the user license, "users_view_count" - the number of users for the live viewer, "users_expire" - the number of days after which the user license expires.

server

private org.json.JSONObject server

Defines the server characteristics: "resultType" - the license status (1 - an error occurred, 2 - the license expired, 3 - the license is still available, 6 - the trial license expired), "packageType" - the product version (0 - an open source product, 1 - the Enterprise Edition, 2 - the Developer Edition), "buildDate" - the build date, "buildVersion" - the build version, "buildNumber" - the build number.

quota

private org.json.JSONObject quota

Defines the user quota value: "users" - the user quota for the user license where "userid" - the id of the user who opened the editor, "expire" - date of license expiration for this user; "users_view" - the user quota for the live viewer where "userid" - the id of the user who opened the editor, "expire" - date of viewing expiration for this user.

url

private String url

Defines the link to the edited document to be saved with the document storage service.

users

private List<String> users

Defines the 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 status 2 and status 6 replies).

version

private String version

Defines the document version.

Constructor Detail

CommandResponse

public CommandResponse()