Package sfs3.client.requests

Class SetRoomVariablesRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.SetRoomVariablesRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class SetRoomVariablesRequest
extends BaseRequest

Sets one or more custom Room Variables in a Room.

When a Room Variable is set, the roomVariablesUpdate event is dispatched to all the users in the target Room, including the user who updated it. Also, if the Room Variable is global (see the SFSRoomVariable class description), the event is dispatched to all users who subscribed the Group to which the target Room is associated.

See Also:

• SFSEvent.ROOM_VARIABLES_UPDATE
• SFSRoomVariable

Field Summary

Fields

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

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
SetRoomVariablesRequest(List<RoomVariable> roomVariables)
SetRoomVariablesRequest(List<RoomVariable> roomVariables, Room room)	Creates a new SetRoomVariablesRequest 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_VAR_ROOM

public static final String KEY_VAR_ROOM

See Also:

• Constant Field Values

Internal

KEY_VAR_LIST

public static final String KEY_VAR_LIST

See Also:

• Constant Field Values

Internal

Constructor Details

SetRoomVariablesRequest

public SetRoomVariablesRequest(List<RoomVariable> roomVariables,
 Room room)

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

Parameters:

roomVariables - A list of RoomVariable objects representing the Room Variables to be set.

room - A Room object representing the Room where to set the Room Variables; if null, the last Room joined by the current user is used.

See Also:

• SmartFox.send(sfs3.client.requests.IClientRequest)
• RoomVariable
• Room

SetRoomVariablesRequest

public SetRoomVariablesRequest(List<RoomVariable> roomVariables)

See Also:

• SetRoomVariablesRequest(java.util.List, sfs3.client.entities.Room)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal