Package com.smartfoxserver.entities

Enum Class SFSRoomSettings

java.lang.Object

java.lang.Enum<SFSRoomSettings>

com.smartfoxserver.entities.SFSRoomSettings

All Implemented Interfaces:

Serializable, Comparable<SFSRoomSettings>, Constable

public enum SFSRoomSettings
extends Enum<SFSRoomSettings>

These flags are used to configure the Room behavior

See Also:

• SFSRoom

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CAPACITY_CHANGE	Toggles the ability to change the capacity of a Room at runtime
PASSWORD_STATE_CHANGE	Toggles the ability to change the password of a Room at runtime
PUBLIC_MESSAGES	Toggles the ability to send public messages in a Room at runtime
ROOM_NAME_CHANGE	Toggles the ability to change the name of a Room at runtime
USER_COUNT_CHANGE_EVENT	Toggles the notifications changes in the count of Users and Spectators in a Room
USER_ENTER_EVENT	Toggles the notifications for Users entering the Room
USER_EXIT_EVENT	Toggles the notifications for Users leaving the Room
USER_VARIABLES_UPDATE_EVENT	Toggles the notifications for UserVariables changes the Room

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ROOM_NAME_CHANGE

public static final SFSRoomSettings ROOM_NAME_CHANGE

Toggles the ability to change the name of a Room at runtime

PASSWORD_STATE_CHANGE

public static final SFSRoomSettings PASSWORD_STATE_CHANGE

Toggles the ability to change the password of a Room at runtime

PUBLIC_MESSAGES

public static final SFSRoomSettings PUBLIC_MESSAGES

Toggles the ability to send public messages in a Room at runtime

CAPACITY_CHANGE

public static final SFSRoomSettings CAPACITY_CHANGE

Toggles the ability to change the capacity of a Room at runtime

USER_ENTER_EVENT

public static final SFSRoomSettings USER_ENTER_EVENT

Toggles the notifications for Users entering the Room

USER_EXIT_EVENT

public static final SFSRoomSettings USER_EXIT_EVENT

Toggles the notifications for Users leaving the Room

USER_COUNT_CHANGE_EVENT

public static final SFSRoomSettings USER_COUNT_CHANGE_EVENT

Toggles the notifications changes in the count of Users and Spectators in a Room

USER_VARIABLES_UPDATE_EVENT

public static final SFSRoomSettings USER_VARIABLES_UPDATE_EVENT

Toggles the notifications for UserVariables changes the Room

Method Details

values

public static SFSRoomSettings[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SFSRoomSettings valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null