BanUserRequest Class Reference

#import <BanUserRequest.h>

Inherits BaseRequest.

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

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

Protected Attributes
NSInteger	_userId
NSString *	_message
NSInteger	_delay
NSInteger	_banMode

Detailed Description

Banish a User from the system (for moderators and admins only)

Allows to send a custom message and to set a delay in seconds. It also allows to choose banning by user name or user IP address

Method Documentation

initWithUserId:message:banMode:delaySeconds:

- (id) initWithUserId:		(NSInteger)	userId
message:		(NSString *)	message
banMode:		(NSInteger)	banMode
delaySeconds:		(NSInteger)	delaySeconds

Parameters

userId	(NSInteger) the id of the User to be banned
message	(NSString *) a custom ban message, if null the message configured on the server side will be used
banMode	(NSInteger) choose between banning by Ip Address or User name
delaySeconds	(NSInteger) a delay in seconds between the message (immediate) and the kick (delayed). Default is 5 seconds

See also

BanMode

KickUserRequest

requestWithUserId:

+ (id) requestWithUserId:

(NSInteger)

userId

Parameters

userId

(NSInteger) the id of the User to be banned

See also

BanMode

KickUserRequest

requestWithUserId:message:banMode:delaySeconds:

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

Parameters

userId	(NSInteger) the id of the User to be banned
message	(NSString *) a custom ban message, if null the message configured on the server side will be used
banMode	(NSInteger) choose between banning by Ip Address or User name
delaySeconds	(NSInteger) a delay in seconds between the message (immediate) and the kick (delayed). Default is 5 seconds

See also

BanMode

KickUserRequest