QXmpp  Version:0.8.0
 All Classes Functions Variables Enumerations Enumerator Properties Groups
Public Types | Public Member Functions | List of all members
QXmppRosterIq::Item Class Reference

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

#include <QXmppRosterIq.h>

Public Types

enum  SubscriptionType {
  None = 0, From = 1, To = 2, Both = 3,
  Remove = 4, NotSet = 8
}
 An enumeration for type of subscription with the bareJid in the roster. More...

Public Member Functions

 Item ()
 Constructs a new roster entry.
QString bareJid () const
QSet< QString > groups () const
QString name () const
QString subscriptionStatus () const
SubscriptionType subscriptionType () const
void setBareJid (const QString &)
void setGroups (const QSet< QString > &)
void setName (const QString &)
void setSubscriptionStatus (const QString &)
void setSubscriptionType (SubscriptionType)

Detailed Description

The QXmppRosterIq::Item class represents a roster entry.

Member Enumeration Documentation

An enumeration for type of subscription with the bareJid in the roster.

Enumerator:
None 

the user does not have a subscription to the contact's presence information, and the contact does not have a subscription to the user's presence information

From 

the contact has a subscription to the user's presence information, but the user does not have a subscription to the contact's presence information

To 

the user has a subscription to the contact's presence information, but the contact does not have a subscription to the user's presence information

Both 

both the user and the contact have subscriptions to each other's presence information

Remove 

to delete a roster item

NotSet 

the subscription state was not specified

Member Function Documentation

QString QXmppRosterIq::Item::bareJid ( ) const

Returns the bareJid of the roster entry.

Returns
bareJid as a QString
QSet< QString > QXmppRosterIq::Item::groups ( ) const

Returns the groups of the roster entry.

Returns
QSet<QString> list of all the groups
QString QXmppRosterIq::Item::name ( ) const

Returns the name of the roster entry.

Returns
name as a QString
void QXmppRosterIq::Item::setBareJid ( const QString &  bareJid)

Sets the bareJid of the roster entry.

Parameters
bareJidas a QString
void QXmppRosterIq::Item::setGroups ( const QSet< QString > &  groups)

Sets the groups of the roster entry.

Parameters
groupslist of all the groups as a QSet<QString>
void QXmppRosterIq::Item::setName ( const QString &  name)

Sets the name of the roster entry.

Parameters
nameas a QString
void QXmppRosterIq::Item::setSubscriptionStatus ( const QString &  status)

Sets the subscription status of the roster entry. It is the "ask" attribute in the Roster IQ stanza. Its value can be "subscribe" or "unsubscribe" or empty.

Parameters
statusas a QString
void QXmppRosterIq::Item::setSubscriptionType ( SubscriptionType  type)

Sets the subscription type of the roster entry.

Parameters
type
QString QXmppRosterIq::Item::subscriptionStatus ( ) const

Returns the subscription status of the roster entry. It is the "ask" attribute in the Roster IQ stanza. Its value can be "subscribe" or "unsubscribe" or empty.

Returns
subscription status as a QString
QXmppRosterIq::Item::SubscriptionType QXmppRosterIq::Item::subscriptionType ( ) const

Returns the subscription type of the roster entry.


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