Package com.smartfoxserver.core

Enum Class SFSEventParam

java.lang.Object
java.lang.Enum<SFSEventParam>
com.smartfoxserver.core.SFSEventParam
All Implemented Interfaces:
ISFSEventParam, Serializable, Comparable<SFSEventParam>, Constable
public enum SFSEventParam extends Enum<SFSEventParam> implements ISFSEventParam

  • Enum Constant Details

    • ZONE

      public static final SFSEventParam ZONE
      The Zone in which the event was fired ( Zone )

    • ROOM

      public static final SFSEventParam ROOM
      The Room in which the event was fired, where applicable ( Room )

    • USER

      public static final SFSEventParam USER
      The User that generated the event ( User )

    • LOGIN_NAME

      public static final SFSEventParam LOGIN_NAME
      The user name sent at login time ( String )

    • LOGIN_PASSWORD

      public static final SFSEventParam LOGIN_PASSWORD
      The user password sent at login time ( String )

    • LOGIN_IN_DATA

      public static final SFSEventParam LOGIN_IN_DATA
      The custom data sent at login time ( SFSObject )

    • LOGIN_OUT_DATA

      public static final SFSEventParam LOGIN_OUT_DATA
      The custom data to return to the user after a successful login ( SFSObject )

    • JOINED_ROOMS

      public static final SFSEventParam JOINED_ROOMS
      The list of joined Rooms of a User that was disconnected ( List of Room )

    • PLAYER_ID

      public static final SFSEventParam PLAYER_ID
      The PlayerId ( Integer )

    • PLAYER_IDS_BY_ROOM

      public static final SFSEventParam PLAYER_IDS_BY_ROOM
      A map of PlayerId by Room ( Map ) of Room, Integer

    • SESSION

      public static final SFSEventParam SESSION
      The User Session ( Session )

    • DISCONNECTION_REASON

      public static final SFSEventParam DISCONNECTION_REASON
      A reason for the disconnection event, where applicable ( ClientDisconnectionReason )

    • DURATION

      public static final SFSEventParam DURATION
      Duration of an event, for example a User ban

    • MOD_USER

      public static final SFSEventParam MOD_USER
      Moderator/Admin User that triggered a certain operation (for example a Kick or Ban) ( User )

    • VARIABLES

      public static final SFSEventParam VARIABLES
      A list of server variables ( List )

    • VARIABLES_MAP

      public static final SFSEventParam VARIABLES_MAP
      A list of server variables in map ( key/value ) form ( Map )

    • RECIPIENT

      public static final SFSEventParam RECIPIENT
      The recipient of a message ( User )

    • MESSAGE

      public static final SFSEventParam MESSAGE
      The chat message ( String )

    • OBJECT

      public static final SFSEventParam OBJECT
      An object with extra data ( ISFSObject )

    • UPLOAD_FILE_LIST

      public static final SFSEventParam UPLOAD_FILE_LIST
      List of uploaded files as List<UploadedFile> ( List )
      See Also:
      • UploadedFile

    • UPLOAD_HTTP_PARAMS

      public static final SFSEventParam UPLOAD_HTTP_PARAMS
      Custom HTTP parameters passed in the upload HTTP POST call. Parameters starting with a double underscore (e.g. __color, __price) will be detected and routed to the Extension as a Map<String, String> ( Map )

    • CLUSTER_EVENT_PARAMS

      public static final SFSEventParam CLUSTER_EVENT_PARAMS
      A Map<String,Object> of parameters sent from a Node in the Overcast Cluster All values in the Map must be Serializable

  • Method Details

    • values

      public static SFSEventParam[] 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 SFSEventParam 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