Communi  3.5.0
A cross-platform IRC framework written with Qt
Public Member Functions | Properties | List of all members
IrcInviteMessage Class Reference

Represents an invite message.

Inherits IrcMessage.

Public Member Functions

Q_INVOKABLE IrcInviteMessage (IrcConnection *connection)
 
- Public Member Functions inherited from IrcMessage
Q_INVOKABLE IrcMessage (IrcConnection *connection)
 
virtual ~IrcMessage ()
 
Q_INVOKABLE IrcMessageclone (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

QString channel
 
bool reply
 
QString user
 
- 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 IrcMessagefromData (const QByteArray &data, IrcConnection *connection)
 
static Q_INVOKABLE IrcMessagefromParameters (const QString &prefix, const QString &command, const QStringList &parameters, IrcConnection *connection)
 

Constructor & Destructor Documentation

IrcInviteMessage::IrcInviteMessage ( IrcConnection connection)
explicit

Constructs a new IrcInviteMessage with connection.

Property Documentation

QString IrcInviteMessage::channel
read

This property holds the channel in question.

Access function:
bool IrcInviteMessage::reply
read

This property holds whether the message is a reply.

Invite messages are sent in three situations:

  • as a notification of a received invitation (false),
  • as a reply when sending an invitation (true), or
  • as an invite notification when the invite-notify capability is enabled (false).
Access function:
  • bool isReply() const
See also
Irc::RPL_INVITING, Irc::RPL_INVITED, IrcInviteCommand, IRCv3 support
QString IrcInviteMessage::user
read

This property holds the user in question.

Access function:
See also
IRCv3 support