KickUserRequest Class Reference

#import <KickUserRequest.h>

Inherits BaseRequest.

Instance Methods
(id)	- initWithUserId:message:delaySeconds:

Class Methods
(id)	+ requestWithUserId:message:delaySeconds:
(id)	+ requestWithUserId:

Detailed Description

Kicks a User out of the server (for moderators and admins only)

Allows to send a custom message and to set a delay in seconds.

Method Documentation

requestWithUserId:message:delaySeconds:

+ (id) requestWithUserId:		(NSInteger)	userId
message:		(NSString *)	message
delaySeconds:		(NSInteger)	delaySeconds

Parameters

userId	the id of the User to be kicked out of the server
message	a custom kick message, if nil, the message configured on the server side will be used
delaySeconds	a delay in seconds between the message (immediate) and the kick (delayed). Default is 5 seconds

See also

BanUserRequest