QXmppMucItem Class
The QXmppMucItem class represents a chat room "item". More...
| Header: | #include <QXmppMucIq.h> |
- List of all members, including inherited members
- QXmppMucItem is part of Stanzas.
Public Types
| enum | Affiliation { UnspecifiedAffiliation, OutcastAffiliation, NoAffiliation, MemberAffiliation, AdminAffiliation, OwnerAffiliation } |
| enum | Role { UnspecifiedRole, NoRole, VisitorRole, ParticipantRole, ModeratorRole } |
Public Functions
| QString | actor() const |
| QXmppMucItem::Affiliation | affiliation() const |
| bool | isNull() const |
| QString | jid() const |
| QString | nick() const |
| QString | reason() const |
| QXmppMucItem::Role | role() const |
| void | setActor(const QString &actor) |
| void | setAffiliation(QXmppMucItem::Affiliation affiliation) |
| void | setJid(const QString &jid) |
| void | setNick(const QString &nick) |
| void | setReason(const QString &reason) |
| void | setRole(QXmppMucItem::Role role) |
Detailed Description
It is used to convey information such as permissions.
Member Type Documentation
enum QXmppMucItem::Affiliation
This enum is used to represent long-lived permissions in a room (affiliations).
| Constant | Value |
|---|---|
QXmppMucItem::UnspecifiedAffiliation | 0 |
QXmppMucItem::OutcastAffiliation | 1 |
QXmppMucItem::NoAffiliation | 2 |
QXmppMucItem::MemberAffiliation | 3 |
QXmppMucItem::AdminAffiliation | 4 |
QXmppMucItem::OwnerAffiliation | 5 |
enum QXmppMucItem::Role
This enum is used to represent short-lived permissions in a room (roles).
| Constant | Value |
|---|---|
QXmppMucItem::UnspecifiedRole | 0 |
QXmppMucItem::NoRole | 1 |
QXmppMucItem::VisitorRole | 2 |
QXmppMucItem::ParticipantRole | 3 |
QXmppMucItem::ModeratorRole | 4 |
Member Function Documentation
QString QXmppMucItem::actor() const
Returns the actor for this item, for instance the admin who kicked a user out of a room.
See also setActor().
QXmppMucItem::Affiliation QXmppMucItem::affiliation() const
Returns the user's affiliation, i.e. long-lived permissions.
See also setAffiliation().
bool QXmppMucItem::isNull() const
Returns true if the current item is null.
QString QXmppMucItem::jid() const
Returns the user's real JID.
See also setJid().
QString QXmppMucItem::nick() const
Returns the user's nickname.
See also setNick().
QString QXmppMucItem::reason() const
Returns the reason for this item, for example the reason for kicking a user out of a room.
See also setReason().
QXmppMucItem::Role QXmppMucItem::role() const
Returns the user's role, i.e. short-lived permissions.
See also setRole().
void QXmppMucItem::setActor(const QString &actor)
Sets the actor for this item, for instance the admin who kicked a user out of a room.
See also actor().
void QXmppMucItem::setAffiliation(QXmppMucItem::Affiliation affiliation)
Sets the user's affiliation, i.e. long-lived permissions.
See also affiliation().
void QXmppMucItem::setJid(const QString &jid)
Sets the user's real JID.
jid.
See also jid().
void QXmppMucItem::setNick(const QString &nick)
Sets the user's nickname.
nick.
See also nick().
void QXmppMucItem::setReason(const QString &reason)
Sets the reason for this item, for example the reason for kicking a user out of a room.
See also reason().
void QXmppMucItem::setRole(QXmppMucItem::Role role)
Sets the user's role, i.e. short-lived permissions.
See also role().