Sfs2X::Requests::BanUserRequest Class Reference

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

#include <BanUserRequest.h>

Inherits Sfs2X::Requests::BaseRequest.

Public Member Functions
	BanUserRequest (long int userId)
	BanUserRequest(long int, string, BanMode, long int, long int) More...
	BanUserRequest (long int userId, string message)
	BanUserRequest(long int, string, BanMode, long int, long int) More...
	BanUserRequest (long int userId, string message, BanMode banMode)
	BanUserRequest(long int, string, BanMode, long int, long int) More...
	BanUserRequest (long int userId, string message, BanMode banMode, long int delaySeconds)
	BanUserRequest(long int, string, BanMode, long int, long int) More...
	BanUserRequest (long int userId, string message, BanMode banMode, long int delaySeconds, long int durationHours)
	Constructor More...

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

Constructor & Destructor Documentation

BanUserRequest() [1/5]

Sfs2X::Requests::BanUserRequest::BanUserRequest

(

long int

userId

)

BanUserRequest(long int, string, BanMode, long int, long int)

BanUserRequest() [2/5]

Sfs2X::Requests::BanUserRequest::BanUserRequest	(	long int	userId,
		string	message
	)

BanUserRequest(long int, string, BanMode, long int, long int)

BanUserRequest() [3/5]

Sfs2X::Requests::BanUserRequest::BanUserRequest	(	long int	userId,
		string	message,
		BanMode	banMode
	)

BanUserRequest(long int, string, BanMode, long int, long int)

BanUserRequest() [4/5]

Sfs2X::Requests::BanUserRequest::BanUserRequest	(	long int	userId,
		string	message,
		BanMode	banMode,
		long int	delaySeconds
	)

BanUserRequest(long int, string, BanMode, long int, long int)

BanUserRequest() [5/5]

Sfs2X::Requests::BanUserRequest::BanUserRequest	(	long int	userId,
		string	message,
		BanMode	banMode,
		long int	delaySeconds,
		long int	durationHours
	)

Constructor

Parameters

userId	the id of the User to be banned
message	a custom ban message, if null the message configured on the server side will be used
banMode	choose between banning by Ip Address or User name, see BanMode� class
delaySeconds	a delay in seconds between the message (immediate) and the kick (delayed). Default is 5 seconds
durationHours	The duration of the banishment, expressed in hours.

boost::shared_ptr<User> userToBan = ptrSmartFox->UserManager()->GetUserByName("Waldorf"); 

// Ban client by name, using default message configured on server side and default delay time (== 5sec)
boost::shared_ptr<IRequest> request (new BanUserRequest(userToBan)); 
ptrSmartFox->Send(request);