Package sfs3.client.requests

Class UnbanUsersFromRoomRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.UnbanUsersFromRoomRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class UnbanUsersFromRoomRequest
extends BaseRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_MESSAGE
static final String	KEY_ROOM
static final String	KEY_USERS

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, UnbanUsersFromRoom, UnsubscribeRoomGroup

Constructor Summary

Constructors

Constructor	Description
UnbanUsersFromRoomRequest(String userName, Room theRoom)	Unbans a User that was previously banned in the specified Room.
UnbanUsersFromRoomRequest(String userName, Room theRoom, String message)	Unbans a User that was previously banned in the specified Room with an optional moderator message.
UnbanUsersFromRoomRequest(List<String> userNames, Room theRoom, String message)	Unbans a group of Users that were previously banned in the specified Room.

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_USERS

public static final String KEY_USERS

See Also:

• Constant Field Values

Internal

KEY_ROOM

public static final String KEY_ROOM

See Also:

• Constant Field Values

KEY_MESSAGE

public static final String KEY_MESSAGE

See Also:

• Constant Field Values

Constructor Details

UnbanUsersFromRoomRequest

public UnbanUsersFromRoomRequest(String userName,
 Room theRoom)

Unbans a User that was previously banned in the specified Room.

NOTE: To be able to unban a User the sender must be the owner of the Room or have Moderator/Admin privileges.

Parameters:

userName - the User's name

theRoom - the target Room

UnbanUsersFromRoomRequest

public UnbanUsersFromRoomRequest(String userName,
 Room theRoom,
 String message)

Unbans a User that was previously banned in the specified Room with an optional moderator message. If a message is provided it is sent first, then the User is unbanned after a short delay (2-3 seconds).

NOTE: To be able to unban a User the sender must be the owner of the Room or have Moderator/Admin privileges.

Parameters:

userName - the User's name

theRoom - the target Room

message - an optional message

UnbanUsersFromRoomRequest

public UnbanUsersFromRoomRequest(List<String> userNames,
 Room theRoom,
 String message)

Unbans a group of Users that were previously banned in the specified Room. If a message is provided it is sent first, then the User is unbanned after a short delay (2-3 seconds).

NOTE: To be able to unban a User the sender must be the owner of the Room or have Moderator/Admin privileges.

Parameters:

userNames - a list of Users (max 10)

theRoom - the target Room

message - an optional ban message

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

execute

public void execute(ISmartFox sfs)
             throws SFSException

Throws:

SFSException