KDE 4.2 API Reference kopete/protocols/messenger/libpapillon
Papillon::UserContact Class Reference
#include <Papillon/UserContact>
Detailed Description
Manage the user contact information.UserContact represent the self contact. It is used to set the login information, change presence, change nickname, change avatar, change status message and personnal information.
To connect to Windows Live Messenger service, you need to set login information using setLoginInformation(). This is required to be able to successfully login. For more information, see Client.
Definition at line 39 of file usercontact.h.
Public Slots | |
| void | setPersonalInformation (Papillon::ClientInfo::PersonalInformation type, const QString &value) |
| void | setPersonalStatusMessage (const Papillon::StatusMessage &statusMessage) |
| void | setPresence (Papillon::Presence::Status newPresence) |
Public Member Functions | |
| QString | loginCookie () const |
| QString | password () const |
| void | setLoginCookie (const QString &cookie) |
| void | setLoginInformation (const QString &passportId, const QString &password) |
| UserContact (Client *client) | |
| ~UserContact () | |
Constructor & Destructor Documentation
| Papillon::UserContact::UserContact | ( | Client * | client | ) |
Create the UserContact.
You must pass the instance of the Client.
- Parameters:
-
client Instance of the client
Definition at line 43 of file usercontact.cpp.
| Papillon::UserContact::~UserContact | ( | ) |
Member Function Documentation
| QString Papillon::UserContact::loginCookie | ( | ) | const |
| QString Papillon::UserContact::password | ( | ) | const |
Get the password of the user contact.
- Returns:
- password of the user contact.
Definition at line 65 of file usercontact.cpp.
| void Papillon::UserContact::setLoginCookie | ( | const QString & | cookie | ) |
Set the authentication cookie obtained during login process.
- Parameters:
-
cookie Authentication cookie
Definition at line 70 of file usercontact.cpp.
| void Papillon::UserContact::setLoginInformation | ( | const QString & | passportId, | |
| const QString & | password | |||
| ) |
Set login information for the user contact.
This is used during login process to store login information.
- Parameters:
-
passportId Microsoft Passport identifier (ex: test@passport.com) password Password (TODO: Use QSecureArray ?)
Definition at line 59 of file usercontact.cpp.
| void Papillon::UserContact::setPersonalInformation | ( | Papillon::ClientInfo::PersonalInformation | type, | |
| const QString & | value | |||
| ) | [slot] |
Set the personal information to be updated on server.
- Parameters:
-
type The type of the personal information it need to update on server. value New value for the given personal information. Set an empty string to reset the value.
Definition at line 98 of file usercontact.cpp.
| void Papillon::UserContact::setPersonalStatusMessage | ( | const Papillon::StatusMessage & | statusMessage | ) | [slot] |
Set a new personal status message.
- Parameters:
-
statusMessage New personal status message
Definition at line 90 of file usercontact.cpp.
| void Papillon::UserContact::setPresence | ( | Papillon::Presence::Status | newPresence | ) | [slot] |
Change online presence.
- Parameters:
-
newPresence New presence
Definition at line 80 of file usercontact.cpp.
The documentation for this class was generated from the following files:
