Package sfs3.client.requests

Class UnsubscribeRoomGroupRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.UnsubscribeRoomGroupRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class UnsubscribeRoomGroupRequest
extends BaseRequest

Unsubscribes the current user to Room-related events occurring in the specified Group. This allows the user to stop being notified of specific Room events occurring in Rooms belonging to the unsubscribed Group.

If the operation is successful, the current user receives a roomGroupUnsubscribe event; otherwise the roomGroupUnsubscribeError event is fired.

See Also:

• SFSEvent.ROOM_GROUP_UNSUBSCRIBE
• SFSEvent.ROOM_GROUP_UNSUBSCRIBE_ERROR
• SubscribeRoomGroupRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_GROUP_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
UnsubscribeRoomGroupRequest(String groupId)	Creates a new UnsubscribeRoomGroupRequest 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

Constructor Details

UnsubscribeRoomGroupRequest

public UnsubscribeRoomGroupRequest(String groupId)

Creates a new UnsubscribeRoomGroupRequest 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 unsubscribe.

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