IrcAwayMessage Class Reference

Represents an away message. More...

Inherits IrcMessage.

Public Member Functions
Q_INVOKABLE	IrcAwayMessage (IrcConnection *connection)
QString	content () const
Public Member Functions inherited from IrcMessage
Q_INVOKABLE	IrcMessage (IrcConnection *connection)
	~IrcMessage () override
QString	account () const
Q_INVOKABLE IrcMessage *	clone (QObject *parent=nullptr) const
QString	command () const
IrcConnection *	connection () const
QByteArray	encoding () const
Flags	flags () const
QString	host () const
QString	ident () const
IrcNetwork *	network () const
QString	nick () const
QString	parameter (int index) const
QStringList	parameters () const
QString	prefix () const
Q_INVOKABLE void	setFlag (Flag flag, bool on=true)
void	setParameter (int index, const QString &parameter)
void	setTag (const QString &name, const QVariant &tag)
QVariant	tag (const QString &name) const
QVariantMap	tags () const
Q_INVOKABLE bool	testFlag (Flag flag) const
QDateTime	timeStamp () const
Q_INVOKABLE QByteArray	toData () const
Type	type () const

Properties
bool	away
bool	reply
Properties inherited from IrcMessage
bool	implicit
bool	own
bool	valid

Additional Inherited Members
Public Types inherited from IrcMessage
enum	Flag {   None = 0x00 , Own = 0x01 , Identified = 0x02 , Unidentified = 0x04 ,   Playback = 0x08 , Implicit = 0x10 }
enum	Type {   Unknown , Capability , Error , Invite ,   Join , Kick , Mode , Motd ,   Names , Nick , Notice , Numeric ,   Part , Ping , Pong , Private ,   Quit , Topic , WhoReply , Account ,   Away , Whois , Whowas , HostChange ,   Batch }
Static Public Member Functions inherited from IrcMessage
static Q_INVOKABLE IrcMessage *	fromData (const QByteArray &data, IrcConnection *connection)
static Q_INVOKABLE IrcMessage *	fromParameters (const QString &prefix, const QString &command, const QStringList &parameters, IrcConnection *connection)

Detailed Description

Since

3.3

Constructor & Destructor Documentation

IrcAwayMessage()

IrcAwayMessage::IrcAwayMessage ( IrcConnection *  connection )

explicit

Constructs a new IrcAwayMessage with connection.

Member Function Documentation

content()

QString IrcAwayMessage::content

(

)

const

This property holds the message content.

Access function:

• QString content() const

Property Documentation

away

bool IrcAwayMessage::away

read

This property holds whether the user is away or back.

Access function:

• bool isAway() const

reply

bool IrcAwayMessage::reply

read

This property holds whether the message is a reply.

Away messages are sent in three situations:

• as a reply when sending a message (true),
• as a reply when setting away status (true),
• as an away notification when the away-notify capability is enabled (false).

Access function:

• bool isReply() const

See also

Irc::RPL_AWAY, Irc::RPL_NOWAWAY, Irc::RPL_UNAWAY, IRCv3 support