KDE 4.2 API Reference kopete/protocols/messenger/libpapillon
Papillon::ContactList Class Reference
#include <Papillon/ContactList>
Detailed Description
Manage contact list.
Definition at line 37 of file contactlist.h.
Public Slots | |
| void | load () |
Signals | |
| void | contactListLoaded () |
Public Member Functions | |
| QList< Papillon::Contact * > | allowList () const |
| QList< Papillon::Contact * > | blockList () const |
| Contact * | contact (const QString &contactId) |
| ContactList (Client *client) | |
| QList< Papillon::Contact * > | contacts () const |
| QList< Papillon::Contact * > | pendingList () const |
| QList< Papillon::Contact * > | reverseList () const |
| ~ContactList () | |
Constructor & Destructor Documentation
| Papillon::ContactList::ContactList | ( | Client * | client | ) |
| Papillon::ContactList::~ContactList | ( | ) |
Member Function Documentation
| QList< Papillon::Contact * > Papillon::ContactList::allowList | ( | ) | const |
Return the contacts on your allowed list.
Allow list is the list of contacts that you allow to see your presence
- Returns:
- List of Contact on Allow list.
Definition at line 76 of file contactlist.cpp.
| QList< Papillon::Contact * > Papillon::ContactList::blockList | ( | ) | const |
Return the contacts on your block list.
Block list of the list of contacts that you refuse to show your presence.
- Returns:
- List of Contact on Block list.
Definition at line 91 of file contactlist.cpp.
Get the Contact instance for the given contactId.
- Parameters:
-
contactId can be the contact GUID or the passport ID.
- Returns:
- Contact instance if found or 0(null)
Definition at line 136 of file contactlist.cpp.
| void Papillon::ContactList::contactListLoaded | ( | ) | [signal] |
Emitted when contact list and address book has been fetched successfully.
| QList< Papillon::Contact * > Papillon::ContactList::contacts | ( | ) | const |
Return the contacts on your contact list (aka forward list).
- Returns:
- List of Contact on forward list.
Definition at line 62 of file contactlist.cpp.
| void Papillon::ContactList::load | ( | ) | [slot] |
Start the fetching of contact list and address book.
This method start an asynchronous task to fetch the contact list and the address book.
Listen to contactListLoaded() signal to be notified of completion of this task.
Definition at line 152 of file contactlist.cpp.
| QList< Papillon::Contact * > Papillon::ContactList::pendingList | ( | ) | const |
Return the contacts on your pending list.
Pending list is the list of contacts that added you on their contact list and waiting for your approval.
- Returns:
- List of Contact on Pending list.
Definition at line 121 of file contactlist.cpp.
| QList< Papillon::Contact * > Papillon::ContactList::reverseList | ( | ) | const |
Return the contacts on your reverse list.
Reverse list is the lists of contacts that are subscribed to your presence.
- Returns:
- List of Contact on Reverse list.
Definition at line 106 of file contactlist.cpp.
The documentation for this class was generated from the following files:
