com.smartfoxserver.v2.core

Enum SFSEventParam

java.lang.Object

java.lang.Enum<SFSEventParam>

com.smartfoxserver.v2.core.SFSEventParam

All Implemented Interfaces:

ISFSEventParam, java.io.Serializable, java.lang.Comparable<SFSEventParam>

public enum SFSEventParam
extends java.lang.Enum<SFSEventParam>
implements ISFSEventParam

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISCONNECTION_REASON A reason for the disconnection event, where applicable ( ClientDisconnectionReason )
JOINED_ROOMS The list of joined Rooms of a User that was disconnected ( List of Room )
LOGIN_IN_DATA The custom data sent at login time ( SFSObject )
LOGIN_NAME The user name sent at login time ( String )
LOGIN_OUT_DATA The custom data to return to the user after a successful login ( SFSObject )
LOGIN_PASSWORD The user password sent at login time ( String )
MESSAGE The chat message ( String )
OBJECT An object with extra data ( ISFSObject )
PLAYER_ID The PlayerId ( Integer )
PLAYER_IDS_BY_ROOM A map of PlayerId by Room ( Map ) of Room, Integer
RECIPIENT The recipient of a message ( User )
ROOM The Room in which the event was fired, where applicable ( Room )
SESSION The User Session ( Session )
UPLOAD_FILE_LIST List of uploaded files as List<UploadedFile> ( List )
UPLOAD_HTTP_PARAMS Custom HTTP parameters passed in the upload HTTP POST call.
USER The User that generated the event ( User )
VARIABLES A list of server variables ( List )
VARIABLES_MAP A list of server variables in map ( key/value ) form ( Map )
ZONE The Zone in which the event was fired ( Zone )

Method Summary

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

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 )

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 )

Method Detail

values

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

Returns:

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

valueOf

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