Communi  3.7.0
A cross-platform IRC framework written with Qt
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
IrcInviteMessage Class Reference

Represents an invite message.

#include <IrcMessage>

Inherits IrcMessage.

Public Member Functions

Q_INVOKABLE IrcInviteMessage (IrcConnection *connection)
 
QString channel () const
 
QString user () 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 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)
 

Constructor & Destructor Documentation

◆ IrcInviteMessage()

IrcInviteMessage::IrcInviteMessage ( IrcConnection *  connection)
explicit

Constructs a new IrcInviteMessage with connection.

Member Function Documentation

◆ channel()

QString IrcInviteMessage::channel ( ) const

This property holds the channel in question.

Access function:
  • QString channel() const

◆ user()

QString IrcInviteMessage::user ( ) const

This property holds the user in question.

Access function:
  • QString user() const
See also
IRCv3 support

Property Documentation

◆ reply

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