Package sfs3.client.requests

Class BanUsersFromRoomRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.BanUsersFromRoomRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class BanUsersFromRoomRequest
extends BaseRequest

Allows to ban one or more Users from the current Room for a certain amount of time. You must be the Room's owner or another User with Moderator/Admin privileges.

You can ban a single User or a group of Users (max 10), providing a time interval after which they will be able to return to the Room.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_INTERVAL
static final String	KEY_MESSAGE
static final String	KEY_ROOM
static final String	KEY_TIME_UNIT
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
BanUsersFromRoomRequest(List<User> users, Room theRoom, String message)	Bans a group of Users from the Room for 1 hour.
BanUsersFromRoomRequest(List<User> users, Room theRoom, String message, int timeInterval, TimeUnit timeUnit)	Ban up to 10 users for up to 24 hours.
BanUsersFromRoomRequest(User user, Room theRoom, String message)	Bans a User from the Room for 1 hour.
BanUsersFromRoomRequest(User user, Room theRoom, String message, int timeInterval, TimeUnit timeUnit)	Ban a User for up to 24 hours.

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_INTERVAL

public static final String KEY_INTERVAL

See Also:

• Constant Field Values

KEY_TIME_UNIT

public static final String KEY_TIME_UNIT

See Also:

• Constant Field Values

KEY_MESSAGE

public static final String KEY_MESSAGE

See Also:

• Constant Field Values

Constructor Details

BanUsersFromRoomRequest

public BanUsersFromRoomRequest(User user,
 Room theRoom,
 String message)

Bans a User from the Room for 1 hour. To be able to ban a User the sender must be the owner of the Room or have Moderator/Admin privileges.

NOTE: if a message is not provided the ban happens immediately. If a message is provided the message is sent first (as moderator message) then the users is kicked out, with a short delay (2-3 seconds).

Parameters:

user - the User

theRoom - the Room where the User should be banned

message - an optional ban message

BanUsersFromRoomRequest

public BanUsersFromRoomRequest(List<User> users,
 Room theRoom,
 String message)

Bans a group of Users from the Room for 1 hour. To be able to ban a User the sender must be the owner of the Room or have Moderator/Admin privileges

NOTE: if a message is not provided the ban happens immediately. If a message is provided the message is sent first (as moderator message) then the users is kicked out, with a short delay (2-3 seconds).

Parameters:

users - a list of Users (max 10)

theRoom - the Room where the User should be banned

message - an optional ban message

BanUsersFromRoomRequest

public BanUsersFromRoomRequest(User user,
 Room theRoom,
 String message,
 int timeInterval,
 TimeUnit timeUnit)

Ban a User for up to 24 hours. Ban time can be expressed in minutes (1..60) or hours(1..24). An optional moderator message can be sent to the users just banned.

To be able to ban a User the sender must be the owner of the Room or have Moderator/Admin privileges

NOTE: if a message is not provided the ban happens immediately. If a message is provided the message is sent first (as moderator message) then the users is kicked out, with a short delay (2-3 seconds).

Parameters:

user - The User to ban

theRoom - The target Room

message - (optional) A message for the banned users

timeInterval - the time interval

timeUnit - the unit of time (minutes or hours)

BanUsersFromRoomRequest

public BanUsersFromRoomRequest(List<User> users,
 Room theRoom,
 String message,
 int timeInterval,
 TimeUnit timeUnit)

Ban up to 10 users for up to 24 hours. Ban time can be expressed in minutes (1..60) or hours(1..24). An optional moderator message can be sent to the users just banned.

To be able to ban a User the sender must be the owner of the Room or have Moderator/Admin privileges

NOTE: if a message is not provided the ban happens immediately. If a message is provided the message is sent first (as moderator message) then the users is kicked out, with a short delay (2-3 seconds).

Parameters:

users - A list of Users (max 10)

theRoom - The target Room

message - (optional) A message for the banned users

timeInterval - the time interval

timeUnit - the unit of time (minutes or hours)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

execute

public void execute(ISmartFox sfs)
             throws SFSException

Throws:

SFSException