CNoticeMessage Class Reference

#include <Message.h>

Inheritance diagram for CNoticeMessage:

Collaboration diagram for CNoticeMessage:

Public Types
enum	Type {   Type::Unknown, Type::Account, Type::Action, Type::Away,   Type::Capability, Type::CTCP, Type::Error, Type::Invite,   Type::Join, Type::Kick, Type::Mode, Type::Nick,   Type::Notice, Type::Numeric, Type::Part, Type::Ping,   Type::Pong, Type::Quit, Type::Text, Type::Topic,   Type::Wallops }
enum	FormatFlags { IncludeAll = 0x0, ExcludePrefix = 0x1, ExcludeTags = 0x2 }

Public Member Functions
CString	GetText () const
void	SetText (const CString &sText)
CString	GetTarget () const
void	SetTarget (const CString &sTarget)
Type	GetType () const
bool	Equals (const CMessage &Other) const
void	Clone (const CMessage &Other)
CIRCNetwork *	GetNetwork () const
void	SetNetwork (CIRCNetwork *pNetwork)
CClient *	GetClient () const
void	SetClient (CClient *pClient)
CChan *	GetChan () const
void	SetChan (CChan *pChan)
CNick &	GetNick ()
const CNick &	GetNick () const
void	SetNick (const CNick &Nick)
const CString &	GetCommand () const
void	SetCommand (const CString &sCommand)
const VCString &	GetParams () const
CString	GetParams (unsigned int uIdx, unsigned int uLen=-1) const
void	SetParams (const VCString &vsParams)
CString	GetParam (unsigned int uIdx) const
void	SetParam (unsigned int uIdx, const CString &sParam)
const timeval &	GetTime () const
void	SetTime (const timeval &ts)
const MCString &	GetTags () const
void	SetTags (const MCString &mssTags)
CString	GetTag (const CString &sKey) const
void	SetTag (const CString &sKey, const CString &sValue)
CString	ToString (unsigned int uFlags=IncludeAll) const
void	Parse (CString sMessage)
template<typename M >
M &	As () ZNC_LVREFQUAL
template<typename M >
const M &	As () const ZNC_LVREFQUAL
template<typename M , typename = typename std::enable_if< std::is_base_of<CMessage, M>{}>::type>
	operator M & () ZNC_LVREFQUAL
template<typename M , typename = typename std::enable_if< std::is_base_of<CMessage, M>{}>::type>
	operator const M & () const ZNC_LVREFQUAL

Member Enumeration Documentation

enum CMessage::FormatFlags

inherited

Enumerator
IncludeAll
ExcludePrefix
ExcludeTags

enum CMessage::Type

stronginherited

Enumerator
Unknown
Account
Action
Away
Capability
CTCP
Error
Invite
Join
Kick
Mode
Nick
Notice
Numeric
Part
Ping
Pong
Quit
Text
Topic
Wallops

Member Function Documentation

template<typename M >

M& CMessage::As ( )

inlineinherited

template<typename M >

const M& CMessage::As ( ) const

inlineinherited

void CMessage::Clone ( const CMessage &  Other )

inherited

Referenced by CMessage::GetType().

bool CMessage::Equals ( const CMessage &  Other ) const

inherited

Referenced by CBufLine::Equals(), and CMessage::GetType().

CChan* CMessage::GetChan ( ) const

inlineinherited

CClient* CMessage::GetClient ( ) const

inlineinherited

const CString& CMessage::GetCommand ( ) const

inlineinherited

References CMessage::SetCommand().

Referenced by CNumericMessage::GetCode(), CBufLine::GetCommand(), and CCTCPMessage::IsReply().

CIRCNetwork* CMessage::GetNetwork ( ) const

inlineinherited

CNick& CMessage::GetNick ( )

inlineinherited

Referenced by CNickMessage::GetOldNick().

const CNick& CMessage::GetNick ( ) const

inlineinherited

CString CMessage::GetParam ( unsigned int  uIdx ) const

inherited

Referenced by CJoinMessage::GetKey(), CKickMessage::GetKickedNick(), CNickMessage::GetNewNick(), CMessage::GetParams(), CKickMessage::GetReason(), CPartMessage::GetReason(), CQuitMessage::GetReason(), CTargetMessage::GetTarget(), CActionMessage::GetText(), CCTCPMessage::GetText(), GetText(), CTextMessage::GetText(), and CTopicMessage::GetTopic().

const VCString& CMessage::GetParams ( ) const

inlineinherited

References CMessage::GetParam(), CMessage::SetParam(), and CMessage::SetParams().

Referenced by CModeMessage::GetModes().

CString CMessage::GetParams ( unsigned int  uIdx, unsigned int  uLen = -1  ) const

inherited

CString CMessage::GetTag ( const CString &  sKey ) const

inherited

Referenced by CMessage::SetTags().

const MCString& CMessage::GetTags ( ) const

inlineinherited

Referenced by CBufLine::GetTags().

CString CTargetMessage::GetTarget ( ) const

inlineinherited

References CMessage::GetParam().

CString CNoticeMessage::GetText ( ) const

inline

References CMessage::GetParam().

const timeval& CMessage::GetTime ( ) const

inlineinherited

Referenced by CBufLine::GetTime().

Type CMessage::GetType ( ) const

inlineinherited

References CMessage::Clone(), and CMessage::Equals().

template<typename M , typename = typename std::enable_if< std::is_base_of<CMessage, M>{}>::type>

CMessage::operator const M & ( ) const

inlineinherited

template<typename M , typename = typename std::enable_if< std::is_base_of<CMessage, M>{}>::type>

CMessage::operator M & ( )

inlineinherited

void CMessage::Parse ( CString  sMessage )

inherited

Referenced by CBufLine::SetFormat().

void CMessage::SetChan ( CChan *  pChan )

inlineinherited

void CMessage::SetClient ( CClient *  pClient )

inlineinherited

void CMessage::SetCommand ( const CString &  sCommand )

inherited

Referenced by CMessage::GetCommand().

void CMessage::SetNetwork ( CIRCNetwork *  pNetwork )

inlineinherited

void CMessage::SetNick ( const CNick &  Nick )

inlineinherited

References CMessage::Nick.

void CMessage::SetParam ( unsigned int  uIdx, const CString &  sParam  )

inherited

Referenced by CMessage::GetParams(), CJoinMessage::SetKey(), CKickMessage::SetKickedNick(), CNickMessage::SetNewNick(), CKickMessage::SetReason(), CPartMessage::SetReason(), CQuitMessage::SetReason(), CTargetMessage::SetTarget(), CActionMessage::SetText(), CCTCPMessage::SetText(), SetText(), CTextMessage::SetText(), and CTopicMessage::SetTopic().

void CMessage::SetParams ( const VCString &  vsParams )

inherited

Referenced by CMessage::GetParams().

void CMessage::SetTag ( const CString &  sKey, const CString &  sValue  )

inherited

Referenced by CMessage::SetTags().

void CMessage::SetTags ( const MCString &  mssTags )

inlineinherited

References CMessage::GetTag(), and CMessage::SetTag().

Referenced by CBufLine::SetTags().

void CTargetMessage::SetTarget ( const CString &  sTarget )

inlineinherited

References REGISTER_ZNC_MESSAGE, and CMessage::SetParam().

void CNoticeMessage::SetText ( const CString &  sText )

inline

References REGISTER_ZNC_MESSAGE, and CMessage::SetParam().

void CMessage::SetTime ( const timeval &  ts )

inlineinherited

Referenced by CBufLine::SetTime().

CString CMessage::ToString ( unsigned int  uFlags = IncludeAll ) const

inherited

Referenced by CBufLine::GetFormat().

---

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

• Message.h