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

Represents a reply message to a WHOIS command. More...

Inherits IrcMessage.

Public Member Functions

Q_INVOKABLE IrcWhoisMessage (IrcConnection *connection)
 
QString account () const
 
QString address () const
 
QString awayReason () const
 
QStringList channels () const
 
int idle () const
 
QString info () const
 
QString realName () const
 
QString server () const
 
QDateTime since () 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
 

Properties

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

Detailed Description

Since
3.3

Constructor & Destructor Documentation

◆ IrcWhoisMessage()

IrcWhoisMessage::IrcWhoisMessage ( IrcConnection connection)
explicit

Constructs a new IrcWhoisMessage with connection.

Member Function Documentation

◆ account()

QString IrcWhoisMessage::account ( ) const

This property holds the account name of the user.

Access function:
  • QString account() const

◆ address()

QString IrcWhoisMessage::address ( ) const

This property holds the address the user is connecting from.

Access function:
  • QString address() const

◆ awayReason()

QString IrcWhoisMessage::awayReason ( ) const
Since
3.5

This property holds the away reason of the user.

Access function:
  • QString awayReason() const

◆ channels()

QStringList IrcWhoisMessage::channels ( ) const

This property holds the visible list of channels of the user.

Access function:
  • QStringList channels() const

◆ idle()

int IrcWhoisMessage::idle ( ) const

This property holds the number of seconds the user has been idle.

Access function:
  • int idle() const

◆ info()

QString IrcWhoisMessage::info ( ) const

This property holds info of the server the user is on.

Access function:
  • QString info() const

◆ realName()

QString IrcWhoisMessage::realName ( ) const

This property holds the real name of the user.

Access function:
  • QString realName() const

◆ server()

QString IrcWhoisMessage::server ( ) const

This property holds the server address user is on.

Access function:
  • QString server() const

◆ since()

QDateTime IrcWhoisMessage::since ( ) const

This property holds the time since user has been online.

Access function:
  • QDateTime since() const

Property Documentation

◆ secure

bool IrcWhoisMessage::secure
read

This property holds whether the user is using a secure connection.

Access function:
  • bool isSecure() const