Package sfs3.client.requests

Class SubscribeRoomGroupRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.SubscribeRoomGroupRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class SubscribeRoomGroupRequest
extends BaseRequest

Subscribes the current user to Room-related events occurring in the specified Group. This allows the user to be notified of specific Room events even if he didn't join the Room from which the events originated, provided the Room belongs to the subscribed Group.

If the subscription operation is successful, the current user receives a roomGroupSubscribe event; otherwise the roomGroupSubscribeError event is fired.

See Also:

• SFSEvent.ROOM_GROUP_SUBSCRIBE
• SFSEvent.ROOM_GROUP_SUBSCRIBE_ERROR
• UnsubscribeRoomGroupRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_GROUP_ID
static final String	KEY_ROOM_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
SubscribeRoomGroupRequest(String groupId)	Creates a new SubscribeRoomGroupRequest 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_GROUP_ID

public static final String KEY_GROUP_ID

See Also:

• Constant Field Values

Internal

KEY_ROOM_LIST

public static final String KEY_ROOM_LIST

See Also:

• Constant Field Values

Internal

Constructor Details

SubscribeRoomGroupRequest

public SubscribeRoomGroupRequest(String groupId)

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

Parameters:

groupId - The name of the Room Group to subscribe.

See Also:

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

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal