QXmpp  Version:1.3.0
Classes | Public Member Functions | List of all members
QXmppRosterIq Class Reference

The QXmppRosterIq class represents a roster IQ. More...

#include <QXmppRosterIq.h>

Inheritance diagram for QXmppRosterIq:
Inheritance graph
[legend]
Collaboration diagram for QXmppRosterIq:
Collaboration graph
[legend]

Classes

class  Item
 The QXmppRosterIq::Item class represents a roster entry. More...
 

Public Member Functions

 QXmppRosterIq (const QXmppRosterIq &)
 
QXmppRosterIqoperator= (const QXmppRosterIq &)
 
QString version () const
 
void setVersion (const QString &)
 
void addItem (const Item &)
 
QList< Itemitems () const
 
bool mixAnnotate () const
 
void setMixAnnotate (bool)
 
- Public Member Functions inherited from QXmppIq
 QXmppIq (QXmppIq::Type type=QXmppIq::Get)
 
 QXmppIq (const QXmppIq &other)
 Constructs a copy of other.
 
QXmppIqoperator= (const QXmppIq &other)
 Assigns other to this IQ.
 
QXmppIq::Type type () const
 
void setType (QXmppIq::Type)
 
bool isXmppStanza () const override
 
- Public Member Functions inherited from QXmppStanza
 QXmppStanza (const QString &from=QString(), const QString &to=QString())
 
 QXmppStanza (const QXmppStanza &other)
 Constructs a copy of other.
 
virtual ~QXmppStanza ()
 Destroys a QXmppStanza.
 
QXmppStanzaoperator= (const QXmppStanza &other)
 Assigns other to this stanza.
 
QString to () const
 
void setTo (const QString &)
 
QString from () const
 Returns the stanza's sender JID.
 
void setFrom (const QString &)
 
QString id () const
 Returns the stanza's identifier.
 
void setId (const QString &)
 
QString lang () const
 Returns the stanza's language.
 
void setLang (const QString &)
 
QXmppStanza::Error error () const
 Returns the stanza's error.
 
void setError (const QXmppStanza::Error &error)
 
QXmppElementList extensions () const
 
void setExtensions (const QXmppElementList &elements)
 
QList< QXmppExtendedAddressextendedAddresses () const
 
void setExtendedAddresses (const QList< QXmppExtendedAddress > &extendedAddresses)
 

Additional Inherited Members

- Public Types inherited from QXmppIq
enum  Type { Error = 0, Get, Set, Result }
 This enum describes the type of IQ. More...
 

Detailed Description

The QXmppRosterIq class represents a roster IQ.

Member Function Documentation

◆ addItem()

void QXmppRosterIq::addItem ( const Item item)

Adds an item to the roster IQ.

Parameters
item

◆ items()

QList< QXmppRosterIq::Item > QXmppRosterIq::items ( ) const

Returns the roster IQ's items.

◆ mixAnnotate()

bool QXmppRosterIq::mixAnnotate ( ) const

Whether to annotate which items are MIX channels.

Since
QXmpp 1.3

◆ setMixAnnotate()

void QXmppRosterIq::setMixAnnotate ( bool  mixAnnotate)

Sets whether to include which roster items are MIX channels. This MUST only be enabled in get requests.

Since
QXmpp 1.3

◆ setVersion()

void QXmppRosterIq::setVersion ( const QString &  version)

Sets the roster version of IQ.

Parameters
versionas a QString
Since
QXmpp 1.0

◆ version()

QString QXmppRosterIq::version ( ) const

Returns the roster version of IQ.

Returns
version as a QString
Since
QXmpp 1.0

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