Inherits from BaseRequest : NSObject
Declared in BanUserRequest.h
BanUserRequest.m

Overview

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

Class Methods

requestWithUserId:

(NSInteger) the id of the User to be banned

+ (id)requestWithUserId:(NSInteger)userId

Parameters

userId

(NSInteger) the id of the User to be banned

Declared In

BanUserRequest.h

requestWithUserId:message:banMode:delaySeconds:

(NSInteger) the id of the User to be banned

+ (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, see @link BanMode BanMode

delaySeconds

(NSInteger) a delay in seconds between the message (immediate) and the kick (delayed). Default is 5 seconds

Declared In

BanUserRequest.h

Instance Methods

initWithUserId:message:banMode:delaySeconds:

(NSInteger) the id of the User to be banned

- (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, see @link BanMode BanMode

delaySeconds

(NSInteger) a delay in seconds between the message (immediate) and the kick (delayed). Default is 5 seconds

Declared In

BanUserRequest.h