KDE 4.2 API Reference kopete/protocols/messenger/libpapillon
Papillon::Contact Class Reference
#include <Papillon/Contact>
Detailed Description
A Contact and all its information Hold client feature, presence for a single contact.This is managed by ContactList.
Definition at line 34 of file contact.h.
Public Member Functions | |
| void | addToList (const Papillon::ContactListEnums::ListFlags &list) |
| ClientInfo::Features | clientFeatures () const |
| Contact (QObject *parent=0) | |
| QString | contactId () const |
| QString | displayName () const |
| Papillon::ContactListEnums::ListFlags | lists () const |
| QString | passportId () const |
| void | removeFromList (const Papillon::ContactListEnums::ListFlags &list) |
| void | setClientFeatures (const ClientInfo::Features &features) |
| void | setContactId (const QString &contactId) |
| void | setDisplayName (const QString &displayName) |
| void | setPassportId (const QString &passportId) |
| ~Contact () | |
Constructor & Destructor Documentation
| Papillon::Contact::Contact | ( | QObject * | parent = 0 |
) |
| Papillon::Contact::~Contact | ( | ) |
Member Function Documentation
| void Papillon::Contact::addToList | ( | const Papillon::ContactListEnums::ListFlags & | list | ) |
Add the contact to the given list.
You can pass multiple list flag to this method.
- Parameters:
-
list Lists on which the contact will be added.
Definition at line 82 of file contact.cpp.
| ClientInfo::Features Papillon::Contact::clientFeatures | ( | ) | const |
| QString Papillon::Contact::contactId | ( | ) | const |
Get contact ID.
Contact ID is a unique GUID used to identity the contact.
- Returns:
- Contact ID as a GUID.
Definition at line 47 of file contact.cpp.
| QString Papillon::Contact::displayName | ( | ) | const |
Get display name for this contact.
- Returns:
- Display name for this contact.
Definition at line 92 of file contact.cpp.
| Papillon::ContactListEnums::ListFlags Papillon::Contact::lists | ( | ) | const |
Get the lists on which the contact is subscribed.
- Returns:
- The list flags.
Definition at line 77 of file contact.cpp.
| QString Papillon::Contact::passportId | ( | ) | const |
Get Passport ID for this contact.
Passport ID is in this form: example@passport.com
- Returns:
- Passport ID
Definition at line 57 of file contact.cpp.
| void Papillon::Contact::removeFromList | ( | const Papillon::ContactListEnums::ListFlags & | list | ) |
Remove the contact from the given list.
You can pass multiple list flag to this method.
- Parameters:
-
list Lists on which the contact will be removed.
Definition at line 87 of file contact.cpp.
| void Papillon::Contact::setClientFeatures | ( | const ClientInfo::Features & | features | ) |
Set clients features for this contact.
- Parameters:
-
features New client features
Definition at line 72 of file contact.cpp.
| void Papillon::Contact::setContactId | ( | const QString & | contactId | ) |
Set Contact ID (this is a GUID).
- Parameters:
-
contactId Contact GUID.
Definition at line 52 of file contact.cpp.
| void Papillon::Contact::setDisplayName | ( | const QString & | displayName | ) |
Set display name for this contact.
- Parameters:
-
displayName Display name to set
Definition at line 97 of file contact.cpp.
| void Papillon::Contact::setPassportId | ( | const QString & | passportId | ) |
Set Passport ID for this contact.
- Parameters:
-
passportId Passport ID
Definition at line 62 of file contact.cpp.
The documentation for this class was generated from the following files:
