Communi  3.7.0
A cross-platform IRC framework written with Qt
Loading...
Searching...
No Matches
IrcJoinMessage Class Reference

Represents a join message.

#include <IrcMessage>

Inherits IrcMessage.

Public Member Functions

Q_INVOKABLE IrcJoinMessage (IrcConnection *connection)
QString account () const
QString channel () const
QString realName () const
Public Member Functions inherited from IrcMessage
Q_INVOKABLE IrcMessage (IrcConnection *connection)
 ~IrcMessage () override
QString account () const
Q_INVOKABLE IrcMessageclone (QObject *parent=nullptr) const
QString command () const
IrcConnectionconnection () const
QByteArray encoding () const
Flags flags () const
QString host () const
QString ident () const
IrcNetworknetwork () 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

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 IrcMessagefromData (const QByteArray &data, IrcConnection *connection)
static Q_INVOKABLE IrcMessagefromParameters (const QString &prefix, const QString &command, const QStringList &parameters, IrcConnection *connection)
Properties inherited from IrcMessage
bool implicit
bool own
bool valid

Constructor & Destructor Documentation

◆ IrcJoinMessage()

IrcJoinMessage::IrcJoinMessage ( IrcConnection * connection)
explicit

Constructs a new IrcJoinMessage with connection.

Member Function Documentation

◆ account()

QString IrcJoinMessage::account ( ) const
Since
3.3

This property holds the account name of the user.

Note
Only set if the extended-join capability is enabled and the user has identified with services.
Access function:
  • QString account() const
See also
IRCv3 support

◆ channel()

QString IrcJoinMessage::channel ( ) const

This property holds the channel in question.

Access function:
  • QString channel() const

◆ realName()

QString IrcJoinMessage::realName ( ) const
Since
3.3

This property holds the real name of the user.

Note
Only set if the extended-join capability is enabled.
Access function:
  • QString realName() const
See also
IRCv3 support