IrcAwayMessage Class Reference

Represents an away message. More...

Inherits IrcMessage.

Public Member Functions
Q_INVOKABLE	IrcAwayMessage (IrcConnection *connection)
Public Member Functions inherited from IrcMessage
Q_INVOKABLE	IrcMessage (IrcConnection *connection)
virtual	~IrcMessage ()
Q_INVOKABLE IrcMessage *	clone (QObject *parent=0) const
QByteArray	encoding () const
QString	parameter (int index) 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
Q_INVOKABLE bool	testFlag (Flag flag) const
Q_INVOKABLE QByteArray	toData () const

Properties
bool	away
QString	content
bool	reply
Properties inherited from IrcMessage
QString	account
QString	command
IrcConnection	connection
Flags	flags
QString	host
QString	ident
bool	implicit
IrcNetwork	network
QString	nick
bool	own
QStringList	parameters
QString	prefix
QVariantMap	tags
QDateTime	timeStamp
Type	type
bool	valid

Additional Inherited Members
Public Types inherited from IrcMessage
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 ( IrcConnection *  connection )

explicit

Constructs a new IrcAwayMessage with connection.

Property Documentation

bool IrcAwayMessage::away

read

This property holds whether the user is away or back.

Access function:

• bool isAway() const

QString IrcAwayMessage::content

read

This property holds the message content.

Access function:

• QString content() const

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