Class SFS2X.Requests.System.BanUserRequest
Banishes a user from the server.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
SFS2X.Requests.System.BanUserRequest(userId, message, banMode, delaySeconds, durationHours)
Creates a new BanUserRequest instance.
|
Class Detail
This request banishes a user from the server. The current user must have administration or moderation privileges in order to be able to ban another user (see the User.privilegeId property). The user can be banned by name or by IP address (see the BanMode class). Also, the request allows sending a message to the banned user (to make clear the reason of the following disconnection) which is delivered by means of the moderatorMessage event.
Differently from the user being kicked (see the KickUserRequest request), a banned user won't be able to connect to the SmartFoxServer instance until the banishment expires (after 24 hours for client-side banning) or an administrator removes his name/IP address from the list of banned users by means of the SmartFoxServer 2X Administration Tool.
The following example bans the user Jack from the system:
function someMethod()
{
var userToBan = sfs.userManager.getUserByName("Jack");
sfs.send(new SFS2X.Requests.System.BanUserRequest(userToBan.id));
}
- Parameters:
- {Number} userId
- The id of the user to be banned.
- {String} message Optional, Default: null
- A custom message to be delivered to the user before banning him; if
null, the default message configured in the SmartFoxServer 2X Administration Tool is used. - {Number} banMode Optional, Default: BY_NAME
- One of the ban modes defined in the BanMode class.
- {Number} delaySeconds Optional, Default: 5
- The number of seconds after which the user is banned after receiving the ban message.
- {Number} durationHours Optional, Default: 24
- The duration of the banishment, expressed in hours.