#include <rosteritemdata.h>
A class holding roster item data.
You should not need to use this class directly.
- Author
- Jakob Schröter js@ca.nosp@m.maya.nosp@m..net
- Since
- 1.0
Definition at line 36 of file rosteritemdata.h.
◆ RosterItemData() [1/5]
Constructs a new item of the roster.
- Parameters
-
jid | The JID of the contact. |
name | The displayed name of the contact. |
groups | A list of groups the contact belongs to. |
Definition at line 46 of file rosteritemdata.h.
◆ RosterItemData() [2/5]
Constructs a new item of the roster, scheduled for removal.
- Parameters
-
jid | The JID of the contact to remove. |
Definition at line 56 of file rosteritemdata.h.
◆ RosterItemData() [3/5]
◆ RosterItemData() [4/5]
Constructs a new item of the roster.
- Parameters
-
jid | The JID of the contact. |
name | The displayed name of the contact. |
groups | A list of groups the contact belongs to. |
- Deprecated:
- Will be removed for 1.1.
Definition at line 78 of file rosteritemdata.h.
◆ RosterItemData() [5/5]
Constructs a new item of the roster, scheduled for removal.
- Parameters
-
jid | The JID of the contact to remove. |
- Deprecated:
- Will be removed for 1.1.
Definition at line 89 of file rosteritemdata.h.
◆ ~RosterItemData()
◆ changed()
Whether the item has unsynchronized changes.
- Returns
- True if the item has unsynchronized changes, false otherwise.
Definition at line 181 of file rosteritemdata.h.
◆ groups()
◆ jid()
GLOOX_DEPRECATED const std::string& jid |
( |
| ) |
const |
|
inline |
◆ jidJID()
const JID& jidJID |
( |
| ) |
const |
|
inline |
◆ name()
const std::string& name |
( |
| ) |
const |
|
inline |
Retrieves the displayed name of a contact/roster item.
- Returns
- The contact's name.
Definition at line 127 of file rosteritemdata.h.
◆ remove()
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 188 of file rosteritemdata.h.
◆ setGroups()
◆ setName()
void setName |
( |
const std::string & |
name | ) |
|
|
inline |
Sets the displayed name of a contact/roster item.
- Parameters
-
name | The contact's new name. |
Definition at line 117 of file rosteritemdata.h.
◆ setSubscription()
void setSubscription |
( |
const std::string & |
subscription, |
|
|
const std::string & |
ask |
|
) |
| |
|
inline |
Sets the current subscription status of the contact.
- Parameters
-
subscription | The current subscription. |
ask | Whether a subscription request is pending. |
Definition at line 134 of file rosteritemdata.h.
◆ setSynchronized()
◆ subscription()
Returns the current subscription type between the remote and the local entity.
- Returns
- The subscription type.
Definition at line 159 of file rosteritemdata.h.
◆ tag()
Retruns a Tag representation of the roster item data.
- Returns
- A Tag representation.
Definition at line 199 of file rosteritemdata.h.
◆ m_jid
GLOOX_DEPRECATED std::string m_jid |
|
protected |
◆ m_jidJID
The documentation for this class was generated from the following file: