com.onlyoffice.model.documenteditor.callback.action

Enum Type

java.lang.Object

java.lang.Enum<Type>

com.onlyoffice.model.documenteditor.callback.action.Type

All Implemented Interfaces:

Serializable, Comparable<Type>

public enum Type
extends Enum<Type>

Defines the action type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLICK_FORCESAVE The user clicks the forcesave button (the type ID is 2).
CONNECTED A new user connects to the document co-editing (the type ID is 1).
DISCONNECTED The user disconnects from the document co-editing (the type ID is 0).

Field Summary

Fields

Modifier and Type	Field and Description
private static Map<Integer,Type>	BY_ID Defines a map of the action types with their IDs.
private int	id Defines the action type ID.

Method Summary

Modifier and Type	Method and Description
(package private) int	getId() Returns the action type ID.
static Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static Type	valueOfId(Integer code) Returns the enum constant of this type with the specified ID.
static Type[]	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

DISCONNECTED

public static final Type DISCONNECTED

The user disconnects from the document co-editing (the type ID is 0).

CONNECTED

public static final Type CONNECTED

A new user connects to the document co-editing (the type ID is 1).

CLICK_FORCESAVE

public static final Type CLICK_FORCESAVE

The user clicks the forcesave button (the type ID is 2).

Field Detail

id

private final int id

Defines the action type ID.

BY_ID

private static final Map<Integer,Type> BY_ID

Defines a map of the action types with their IDs.

Method Detail

values

public static Type[] 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 (Type c : Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static Type 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

valueOfId

public static Type valueOfId(Integer code)

Returns the enum constant of this type with the specified ID. The integer must match exactly an identifier used to declare an enum constant in this type.

Parameters:

code - The ID of the enum constant to be returned.

Returns:

The enum constant with the specified ID.

getId

int getId()

Returns the action type ID.

Returns:

The action type ID.