| Package | com.smartfoxserver.v2.requests |
| Class | public class KickUserRequest |
| Inheritance | KickUserRequest  com.smartfoxserver.v2.requests.BaseRequest |
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.
See also
| Method | Defined By | ||
|---|---|---|---|
KickUserRequest(userId:int, message:String = null, delaySeconds:int = 5)
Creates a new KickUserRequest instance. | KickUserRequest | ||
| KickUserRequest | () | Constructor |
public function KickUserRequest(userId:int, message:String = null, delaySeconds:int = 5)Creates a new KickUserRequest instance. The instance must be passed to the SmartFox.send() method for the request to be performed.
ParametersuserId:int — The id of the user to be kicked.
| |
message:String (default = null)null, the default message configured in the SmartFoxServer 2X Administration Tool is used.
| |
delaySeconds:int (default = 5) |
See also
private function someMethod():void
{
var userToKick:User = sfs.userManager.getUserByName("Jack");
sfs.send(new KickUserRequest(userToKick.id));
}