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

Represents a private message.

#include <IrcMessage>

Inherits IrcMessage.

Public Member Functions

Q_INVOKABLE IrcPrivateMessage (IrcConnection *connection)
QString content () const
QString statusPrefix () const
QString target () 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 action
bool private
bool request
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)

Constructor & Destructor Documentation

◆ IrcPrivateMessage()

IrcPrivateMessage::IrcPrivateMessage ( IrcConnection * connection)
explicit

Constructs a new IrcPrivateMessage with connection.

Member Function Documentation

◆ content()

QString IrcPrivateMessage::content ( ) const

This property holds the message content.

Access function:
  • QString content() const

◆ statusPrefix()

QString IrcPrivateMessage::statusPrefix ( ) const
Since
3.4

This property holds the status prefix of the message.

Access function:
  • QString statusPrefix() const

◆ target()

QString IrcPrivateMessage::target ( ) const

This property holds the target channel or user in question.

Access function:
  • QString target() const

Property Documentation

◆ action

bool IrcPrivateMessage::action
read

This property is true if the message is an action; otherwise false.

Access function:
  • bool isAction() const

◆ private

bool IrcPrivateMessage::private
read

This property is true if the message is private, or false if it is a channel message.

Access function:
  • bool isPrivate() const

◆ request

bool IrcPrivateMessage::request
read

This property is true if the message is a request; otherwise false.

Access function:
  • bool isRequest() const