Package com.smartfoxserver.v2.entities

Enum SFSRoomSettings

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SFSRoomSettings>
    public enum SFSRoomSettings
extends java.lang.Enum<SFSRoomSettings>
    These flags are used to configure the Room behavior
    See Also:
    SFSRoom

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static SFSRoomSettings valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SFSRoomSettings[] 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

      • 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 Detail

      • values

        public static SFSRoomSettings[] 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 (SFSRoomSettings c : SFSRoomSettings.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SFSRoomSettings valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null