The InspIRCd Project
Home | Developers | Wiki | Forums | Bug Tracker | SVN | Download
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

ListModeRequest Class Reference

A request used to check if a user is on a channel's list or not. More...

#include <u_listmode.h>

Inheritance diagram for ListModeRequest:

Inheritance graph
[legend]
Collaboration diagram for ListModeRequest:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ListModeRequest (Module *sender, Module *target, User *u, Channel *c)
 Check if a user is on a channel's list.
 ListModeRequest (Module *sender, Module *target, std::string literalstr, char extbanchar, Channel *channel)
 Check if a literal string is on a channel's list, optionally using an extban char.
 ListModeRequest (Module *sender, Module *target, User *u, char extbanchar, Channel *channel)
 Check if a literal string is on a channel's list, optionally using an extban char.
 ~ListModeRequest ()
 Destructor.

Public Attributes

Useruser
std::string literal
const char extban
Channelchan

Detailed Description

A request used to check if a user is on a channel's list or not.

Definition at line 54 of file u_listmode.h.


Constructor & Destructor Documentation

ListModeRequest::ListModeRequest Module sender,
Module target,
User u,
Channel c
[inline]
 

Check if a user is on a channel's list.

The Event::Send() event returns the ban string if the user is on the channel's list, or NULL if the user is not on the list.

Parameters:
sender Sending module
target Target module
u User to check against
c Channel to check against

Definition at line 70 of file u_listmode.h.

ListModeRequest::ListModeRequest Module sender,
Module target,
std::string  literalstr,
char  extbanchar,
Channel channel
[inline]
 

Check if a literal string is on a channel's list, optionally using an extban char.

The Event::Send() event returns the ban string if the user is on the channel's list, or NULL if the user is not on the list.

Parameters:
sender Sending module
target Target module
literalstr String to check against, e.g. "Bob!Bobbertson@weeblshouse"
extbanchar Extended ban character to use for the match, or a null char if not using extban

Definition at line 82 of file u_listmode.h.

ListModeRequest::ListModeRequest Module sender,
Module target,
User u,
char  extbanchar,
Channel channel
[inline]
 

Check if a literal string is on a channel's list, optionally using an extban char.

The Event::Send() event returns the ban string if the user is on the channel's list, or NULL if the user is not on the list.

Parameters:
sender Sending module
target Target module
User to check against, e.g. "Bob!Bobbertson@weeblshouse"
extbanchar Extended ban character to use for the match, or a null char if not using extban

Definition at line 94 of file u_listmode.h.

ListModeRequest::~ListModeRequest  )  [inline]
 

Destructor.

Definition at line 100 of file u_listmode.h.


Member Data Documentation

Channel* ListModeRequest::chan
 

Definition at line 60 of file u_listmode.h.

Referenced by ListModeBase::DoOnRequest().

const char ListModeRequest::extban
 

Definition at line 59 of file u_listmode.h.

Referenced by ListModeBase::DoOnRequest().

std::string ListModeRequest::literal
 

Definition at line 58 of file u_listmode.h.

Referenced by ListModeBase::DoOnRequest().

User* ListModeRequest::user
 

Definition at line 57 of file u_listmode.h.

Referenced by ListModeBase::DoOnRequest().


The documentation for this class was generated from the following file: