Package sfs3.client.requests

Class SetUserVariablesRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.SetUserVariablesRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class SetUserVariablesRequest
extends BaseRequest

Sets one or more custom User Variables for the current user.

When a User Variable is set, the userVariablesUpdate event is dispatched to all the users in all the Rooms joined by the current user, including himself.

NOTE: the userVariablesUpdate event is dispatched to users in a specific Room only if it is configured to allow this event (see the RoomSettings.permissions parameter).

See Also:

• SFSEvent.USER_VARIABLES_UPDATE
• RoomSettings.getPermissions()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_USER
static final String	KEY_VAR_LIST

Fields inherited from class sfs3.client.requests.BaseRequest

AddBuddy, AdminMessage, AutoJoin, BanUser, BanUsersFromRoom, BlockBuddy, CallExtension, ChangeRoomCapacity, ChangeRoomName, ChangeRoomPassword, ClusterInviteUsers, ClusterJoinOrCreate, CreateRoom, CreateSFSGame, FindRooms, FindUsers, GameServerConnectionRequired, GenericMessage, GetRoomList, GoOnline, Handshake, InitBuddyList, InvitationReply, InviteUser, JoinRoom, JoinRoomInvite, KEY_ERROR_CODE, KEY_ERROR_PARAMS, KickUser, LeaveRoom, Login, Logout, ManualDisconnection, ModeratorMessage, ObjectMessage, PingPong, PlayerToSpectator, PrivateMessage, PublicMessage, QuickJoinGame, QuickJoinOrCreateRoom, RemoveBuddy, SetBuddyVariables, SetRoomVariables, SetUserPosition, SetUserVariables, sfso, SpectatorToPlayer, SubscribeRoomGroup, targetController, UdpInit, UnsubscribeRoomGroup

Constructor Summary

Constructors

Constructor	Description
SetUserVariablesRequest(List<UserVariable> userVariables)	Creates a new SetUserVariablesRequest instance.

Method Summary

Modifier and Type	Method	Description
void	execute(ISmartFox sfs)
void	validate(ISmartFox sfs)

Methods inherited from class sfs3.client.requests.BaseRequest

getId, getRequest, getTargetController, getTransportType, setId, setTargetController, setTransportType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEY_USER

public static final String KEY_USER

See Also:

• Constant Field Values

Internal

KEY_VAR_LIST

public static final String KEY_VAR_LIST

See Also:

• Constant Field Values

Internal

Constructor Details

SetUserVariablesRequest

public SetUserVariablesRequest(List<UserVariable> userVariables)

Creates a new SetUserVariablesRequest instance. The instance must be passed to the SmartFox.send() method for the request to be performed.

Parameters:

userVariables - A list of UserVariable objects representing the User Variables to be set.

See Also:

• SmartFox.send(sfs3.client.requests.IClientRequest)
• UserVariable

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal