new BanUserRequest(userId[, message][, banMode][, delaySeconds][, durationHours])

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

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 SFSUser.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.

Example

This example bans the user Jack from the system.

function someMethod()
{
	var userToBan = sfs.userManager.getUserByName("Jack");
	sfs.send(new SFS2X.BanUserRequest(userToBan.id));
}

Parameters

Name Type Optional Description

userId

number

 

The id of the user to be banned.

message

string

Yes

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.

Defaults to null.

banMode

number

Yes

One of the ban modes defined in the BanMode class.

Defaults to BanMode.BY_NAME.

delaySeconds

number

Yes

The number of seconds after which the user is banned after receiving the ban message.

Defaults to 5.

durationHours

number

Yes

The duration of the banishment, expressed in hours.

Defaults to 24.

See also
SmartFox#send
SFSEvent.MODERATOR_MESSAGE
SFSUser#privilegeId
KickUserRequest
BanMode