com.onlyoffice.model.commandservice.commandrequest

Enum Command

java.lang.Object

java.lang.Enum<Command>

com.onlyoffice.model.commandservice.commandrequest.Command

All Implemented Interfaces:

Serializable, Comparable<Command>

public enum Command
extends Enum<Command>

Defines the command type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETE_FORGOTTEN This command allows to delete a forgotten file.
DROP This command allows to disconnect the specified users from the document editing service.
FORCESAVE This command allows to forcibly save the document being edited without closing it.
GET_FORGOTTEN This command allows to request a forgotten file.
GET_FORGOTTEN_LIST This command allows to request a list of the forgotten files.
INFO This command allows to request a document status and the list of the identifiers of the users who opened the document for editing.
LICENSE This command allows to request the license from Document Server with information about the server and user quota.
META This command allows to update the meta information of the document for all collaborative editors.
VERSION This command allows to request the current version number of Document Server.

Method Summary

Modifier and Type	Method and Description
static Command	valueOf(String name) Returns the enum constant of this type with the specified name.
static Command[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DELETE_FORGOTTEN

public static final Command DELETE_FORGOTTEN

This command allows to delete a forgotten file.

DROP

public static final Command DROP

This command allows to disconnect the specified users from the document editing service.

FORCESAVE

public static final Command FORCESAVE

This command allows to forcibly save the document being edited without closing it.

GET_FORGOTTEN

public static final Command GET_FORGOTTEN

This command allows to request a forgotten file.

GET_FORGOTTEN_LIST

public static final Command GET_FORGOTTEN_LIST

This command allows to request a list of the forgotten files.

INFO

public static final Command INFO

This command allows to request a document status and the list of the identifiers of the users who opened the document for editing.

LICENSE

public static final Command LICENSE

This command allows to request the license from Document Server with information about the server and user quota.

META

public static final Command META

This command allows to update the meta information of the document for all collaborative editors.

VERSION

public static final Command VERSION

This command allows to request the current version number of Document Server.

Method Detail

values

public static Command[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Command c : Command.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Command valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null