Class SFS2X.Requests.System.KickUserRequest
Kicks a user out of the server.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
SFS2X.Requests.System.KickUserRequest(userId, message, delaySeconds)
Creates a new KickUserRequest instance.
|
Class Detail
SFS2X.Requests.System.KickUserRequest(userId, message, delaySeconds)
Creates a new KickUserRequest instance.
The instance must be passed to the SmartFox.send() method for the request to be performed.
This request kicks a user out of the server. The current user must have administration or moderation privileges in order to be able to kick another user (see the User.privilegeId property). The request allows sending a message to the kicked user (to make clear the reason of the following disconnection) which is delivered by means of the moderatorMessage event.
Differently from the user being banned (see the BanUserRequest request), a kicked user will be able to reconnect to the SmartFoxServer instance immediately.
The following example kicks the user Jack from the system:
function someMethod()
{
var userToKick = sfs.userManager.getUserByName("Jack");
sfs.send(new SFS2X.Requests.System.KickUserRequest(userToKick.id));
}
- Parameters:
- {Number} userId
- The id of the user to be kicked.
- {String} message Optional, Default: null
- A custom message to be delivered to the user before kicking him; if
null, the default message configured in the SmartFoxServer 2X Administration Tool is used. - {Number} delaySeconds Optional, Default: 5
- The number of seconds after which the user is kicked after receiving the kick message.