Package sfs3.client.requests

Class JoinRoomRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.JoinRoomRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class JoinRoomRequest
extends BaseRequest

Joins the current user in a Room.

If the operation is successful, the current user receives a roomJoin event; otherwise the roomJoinError event is fired. This usually happens when the Room is full, or the password is wrong in case of password protected Rooms.

Depending on the Room configuration defined upon its creation (see the RoomSettings.events setting), when the current user joins it, the following events might be fired: userEnterRoom, dispatched to the other users inside the Room to warn them that a new user has arrived; userCountChange, dispatched to all clients which subscribed the Group to which the Room belongs, to update the count of users inside the Room.

See Also:

• SFSEvent.ROOM_JOIN
• SFSEvent.ROOM_JOIN_ERROR
• SFSEvent.USER_ENTER_ROOM
• SFSEvent.USER_COUNT_CHANGE
• RoomSettings.getEvents()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_AS_SPECTATOR
static final String	KEY_PASS
static final String	KEY_ROOM
static final String	KEY_ROOM_ID
static final String	KEY_ROOM_NAME
static final String	KEY_ROOM_TO_LEAVE
static final String	KEY_USER_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
JoinRoomRequest(Object id)
JoinRoomRequest(Object id, String pass)
JoinRoomRequest(Object id, String pass, Integer roomIdToLeave)
JoinRoomRequest(Object id, String pass, Integer roomIdToLeave, boolean asSpectator)	Creates a new JoinRoomRequest 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_ROOM

public static final String KEY_ROOM

See Also:

• Constant Field Values

Internal

KEY_USER_LIST

public static final String KEY_USER_LIST

See Also:

• Constant Field Values

Internal

KEY_ROOM_NAME

public static final String KEY_ROOM_NAME

See Also:

• Constant Field Values

Internal

KEY_ROOM_ID

public static final String KEY_ROOM_ID

See Also:

• Constant Field Values

Internal

KEY_PASS

public static final String KEY_PASS

See Also:

• Constant Field Values

Internal

KEY_ROOM_TO_LEAVE

public static final String KEY_ROOM_TO_LEAVE

See Also:

• Constant Field Values

Internal

KEY_AS_SPECTATOR

public static final String KEY_AS_SPECTATOR

See Also:

• Constant Field Values

Internal

Constructor Details

JoinRoomRequest

public JoinRoomRequest(Object id,
 String pass,
 Integer roomIdToLeave,
 boolean asSpectator)

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

Parameters:

id - The id or the name of the Room to be joined.

pass - The password of the Room, in case it is password protected.

roomIdToLeave - The id of a previously joined Room that the user should leave when joining the new Room. By default, the last joined Room is left; if a negative number is passed, no previous Room is left.

asSpectator - true to join the Room as a spectator (in Game Rooms only).

See Also:

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

JoinRoomRequest

public JoinRoomRequest(Object id,
 String pass,
 Integer roomIdToLeave)

See Also:

• JoinRoomRequest(Object, String, Integer, boolean)

JoinRoomRequest

public JoinRoomRequest(Object id,
 String pass)

See Also:

• JoinRoomRequest(Object, String, Integer, boolean)

JoinRoomRequest

public JoinRoomRequest(Object id)

See Also:

• JoinRoomRequest(Object, String, Integer, boolean)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal