QXmpp  Version:1.3.0
Public Types | Public Member Functions | List of all members
QXmppMucItem Class Reference

The QXmppMucItem class represents a chat room "item". More...

#include <QXmppMucIq.h>

Public Types

enum  Affiliation {
  UnspecifiedAffiliation, OutcastAffiliation, NoAffiliation, MemberAffiliation,
  AdminAffiliation, OwnerAffiliation
}
 This enum is used to represent long-lived permissions in a room (affiliations).
 
enum  Role {
  UnspecifiedRole, NoRole, VisitorRole, ParticipantRole,
  ModeratorRole
}
 This enum is used to represent short-lived permissions in a room (roles).
 

Public Member Functions

bool isNull () const
 Returns true if the current item is null.
 
QString actor () const
 
void setActor (const QString &actor)
 
Affiliation affiliation () const
 Returns the user's affiliation, i.e. long-lived permissions.
 
void setAffiliation (Affiliation affiliation)
 
QString jid () const
 Returns the user's real JID.
 
void setJid (const QString &jid)
 
QString nick () const
 Returns the user's nickname.
 
void setNick (const QString &nick)
 
QString reason () const
 
void setReason (const QString &reason)
 
Role role () const
 Returns the user's role, i.e. short-lived permissions.
 
void setRole (Role role)
 

Detailed Description

The QXmppMucItem class represents a chat room "item".

It is used to convey information such as permissions.

Member Function Documentation

◆ actor()

QString QXmppMucItem::actor ( ) const

Returns the actor for this item, for instance the admin who kicked a user out of a room.

◆ reason()

QString QXmppMucItem::reason ( ) const

Returns the reason for this item, for example the reason for kicking a user out of a room.

◆ setActor()

void QXmppMucItem::setActor ( const QString &  actor)

Sets the actor for this item, for instance the admin who kicked a user out of a room.

◆ setAffiliation()

void QXmppMucItem::setAffiliation ( Affiliation  affiliation)

Sets the user's affiliation, i.e. long-lived permissions.

Parameters
affiliation

◆ setJid()

void QXmppMucItem::setJid ( const QString &  jid)

Sets the user's real JID.

Parameters
jid

◆ setNick()

void QXmppMucItem::setNick ( const QString &  nick)

Sets the user's nickname.

Parameters
nick

◆ setReason()

void QXmppMucItem::setReason ( const QString &  reason)

Sets the reason for this item, for example the reason for kicking a user out of a room.

◆ setRole()

void QXmppMucItem::setRole ( Role  role)

Sets the user's role, i.e. short-lived permissions.

Parameters
role

The documentation for this class was generated from the following files: