Package sfs3.client.requests

Class LeaveRoomRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.LeaveRoomRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class LeaveRoomRequest
extends BaseRequest

Leaves one of the Rooms joined by the current user.

Depending on the Room configuration defined upon its creation (see the RoomSettings.events setting), when the current user leaves it, the following events might be fired: userExitRoom, dispatched to all the users inside the Room (including the current user then) to warn them that a user has gone away; 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.USER_EXIT_ROOM
• SFSEvent.USER_COUNT_CHANGE
• RoomSettings.getEvents()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_ROOM_ID

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
LeaveRoomRequest()
LeaveRoomRequest(Room theRoom)	Creates a new LeaveRoomRequest 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_ID

public static final String KEY_ROOM_ID

See Also:

• Constant Field Values

Internal

Constructor Details

LeaveRoomRequest

public LeaveRoomRequest(Room theRoom)

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

Parameters:

theRoom - The Room object corresponding to the Room that the current user must leave. If null, the last Room joined by the user is left.

See Also:

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

LeaveRoomRequest

public LeaveRoomRequest()

See Also:

• LeaveRoomRequest(Room)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal