InspIRCd  3.0
Public Member Functions | List of all members
ClientProtocol::Messages::Kick Struct Reference

#include <clientprotocolmsg.h>

Inheritance diagram for ClientProtocol::Messages::Kick:
ClientProtocol::Message ClientProtocol::MessageSource

Public Member Functions

 Kick (User *source, Membership *memb, const std::string &reason)
 
- Public Member Functions inherited from ClientProtocol::Message
 Message (const char *cmd, User *Sourceuser=NULL)
 
 Message (const char *cmd, const std::string &Sourcestr, User *Sourceuser=NULL)
 
const ParamList & GetParams () const
 
const TagMapGetTags () const
 
const char * GetCommand () const
 
void PushParam (const char *str)
 
void PushParam (const std::string &str)
 
void PushParamRef (const std::string &str)
 
void PushParamPlaceholder ()
 
void ReplaceParam (unsigned int index, const char *str)
 
void ReplaceParam (unsigned int index, const std::string &str)
 
void ReplaceParamRef (unsigned int index, const std::string &str)
 
void AddTag (const std::string &tagname, MessageTagProvider *tagprov, const std::string &val, void *tagdata=NULL)
 
void AddTags (const ClientProtocol::TagMap &newtags)
 
const SerializedMessage & GetSerialized (const SerializedInfo &serializeinfo) const
 
void ClearParams ()
 
void InvalidateCache ()
 
void CopyAll ()
 
void SetSideEffect (bool Sideeffect)
 
bool IsSideEffect () const
 
- Public Member Functions inherited from ClientProtocol::MessageSource
 MessageSource (User *Sourceuser=NULL)
 
 MessageSource (const std::string &Sourcestr, User *Sourceuser=NULL)
 
const std::string * GetSource () const
 
UserGetSourceUser () const
 
void SetSourceUser (User *Sourceuser)
 
void SetSource (const std::string &Sourcestr, User *Sourceuser=NULL)
 
void SetSource (const MessageSource &other)
 

Additional Inherited Members

- Public Types inherited from ClientProtocol::Message
typedef std::vector< ParamParamList
 
- Protected Member Functions inherited from ClientProtocol::Message
void SetCommand (const char *cmd)
 

Detailed Description

KICK message. Sent when a user is kicked from a channel.

Constructor & Destructor Documentation

◆ Kick()

ClientProtocol::Messages::Kick::Kick ( User source,
Membership memb,
const std::string &  reason 
)
inline

Constructor.

Parameters
sourceUser that does the kick.
membMembership of the user being kicked.
reasonKick reason. Must remain valid as long as this object is alive.

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