gloox 1.0
Public Member Functions
RosterItemData Class Reference

A class holding roster item data. More...

#include <rosteritemdata.h>

List of all members.

Public Member Functions

 RosterItemData (const std::string &jid, const std::string &name, const StringList &groups)
 RosterItemData (const std::string &jid)
virtual ~RosterItemData ()
const std::string & jid () const
void setName (const std::string &name)
const std::string & name () const
void setSubscription (const std::string &subscription, const std::string &ask)
SubscriptionType subscription () const
void setGroups (const StringList &groups)
const StringListgroups () const
bool changed () const
bool remove () const
void setSynchronized ()
Tagtag () const

Detailed Description

A class holding roster item data.

You should not need to use this class directly.

Author:
Jakob Schroeter <js@camaya.net>
Since:
1.0

Definition at line 36 of file rosteritemdata.h.


Constructor & Destructor Documentation

RosterItemData ( const std::string &  jid,
const std::string &  name,
const StringList groups 
) [inline]

Constructs a new item of the roster.

Parameters:
jidThe JID of the contact.
nameThe displayed name of the contact.
groupsA list of groups the contact belongs to.

Definition at line 46 of file rosteritemdata.h.

RosterItemData ( const std::string &  jid) [inline]

Constructs a new item of the roster, scheduled for removal.

Parameters:
jidThe JID of the contact to remove.

Definition at line 56 of file rosteritemdata.h.

virtual ~RosterItemData ( ) [inline, virtual]

Virtual destructor.

Definition at line 64 of file rosteritemdata.h.


Member Function Documentation

bool changed ( ) const [inline]

Whether the item has unsynchronized changes.

Returns:
True if the item has unsynchronized changes, false otherwise.

Definition at line 140 of file rosteritemdata.h.

const StringList& groups ( ) const [inline]

Returns the groups this RosterItem belongs to.

Returns:
The groups this item belongs to.

Definition at line 134 of file rosteritemdata.h.

const std::string& jid ( ) const [inline]

Returns the contact's bare JID.

Returns:
The contact's bare JID.

Definition at line 70 of file rosteritemdata.h.

const std::string& name ( ) const [inline]

Retrieves the displayed name of a contact/roster item.

Returns:
The contact's name.

Definition at line 86 of file rosteritemdata.h.

bool remove ( ) const [inline]

Whether the item is scheduled for removal.

Returns:
True if the item is subject to a removal or scheduled for removal, false otherwise.

Definition at line 147 of file rosteritemdata.h.

void setGroups ( const StringList groups) [inline]

Sets the groups this RosterItem belongs to.

Parameters:
groupsThe groups to set for this item.

Definition at line 124 of file rosteritemdata.h.

void setName ( const std::string &  name) [inline]

Sets the displayed name of a contact/roster item.

Parameters:
nameThe contact's new name.

Definition at line 76 of file rosteritemdata.h.

void setSubscription ( const std::string &  subscription,
const std::string &  ask 
) [inline]

Sets the current subscription status of the contact.

Parameters:
subscriptionThe current subscription.
askWhether a subscription request is pending.

Definition at line 93 of file rosteritemdata.h.

void setSynchronized ( ) [inline]

Removes the 'changed' flag from the item.

Definition at line 152 of file rosteritemdata.h.

SubscriptionType subscription ( ) const [inline]

Returns the current subscription type between the remote and the local entity.

Returns:
The subscription type.

Definition at line 118 of file rosteritemdata.h.

Tag* tag ( ) const [inline]

Retruns a Tag representation of the roster item data.

Returns:
A Tag representation.

Definition at line 158 of file rosteritemdata.h.


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