|
|
| ClientAccount (const char* proto, const char* user,
const char* host, bool startup)
| ClientAccount |
Constructor
Parameters:
| proto | The account's protocol |
| user | The account's username |
| host | The account's host |
| startup | True if the account should login at startup |
| ClientAccount (const NamedList& params)
| ClientAccount |
Constructor. Build an account from a list of parameters
Parameters:
| params | The list of parameters used to build this account |
| inline const URI& uri ()
| uri |
[const]
Get this account's URI
Returns: This account's URI
| inline const URI& id ()
| id |
[const]
Get this account's id
Returns: This account's id
| inline ObjList& contacts ()
| contacts |
Get this account's contacts. The caller should lock the account while browsing the list
Returns: This account's contacts list
| const String& toString ()
| toString |
[const virtual]
Get a string representation of this object
Returns: The account's compare id
Reimplemented from GenObject.
| ClientResource* resource (bool ref = false)
| resource |
Get this account's resource
Returns: ClientResource pointer or 0
| void setResource (ClientResource* res = 0)
| setResource |
Set/reset this account's resource
Parameters:
| res | The new account's resource |
| ClientContact* findContact (const String& id, bool ref = false)
| findContact |
[virtual]
Find a contact by its id
Parameters:
| id | The id of the desired contact |
| ref | True to obtain a referenced pointer |
Returns: ClientContact pointer or 0 if not found
| ClientContact* findContact (const String& id, const String& resid,
bool ref = false)
| findContact |
[virtual]
Find a contact having a given id and resource
Parameters:
| id | The id of the desired contact |
| resid | The id of the desired resource |
| ref | True to obtain a referenced pointer |
Returns: ClientContact pointer or 0 if not found
| ClientContact* appendContact (const String& id, const char* name)
| appendContact |
[virtual]
Build a contact and append it to the list
Parameters:
| id | The contact's id |
| name | The contact's name |
Returns: ClientContact pointer or 0 if a contact with the given id already exists
| ClientContact* appendContact (const NamedList& params)
| appendContact |
[virtual]
Build a contact and append it to the list
Parameters:
| params | Contact parameters |
Returns: ClientContact pointer or 0 if a contact with the same id already exists
| ClientContact* removeContact (const String& id, bool delObj = true)
| removeContact |
[virtual]
Remove a contact from list. Reset contact's owner
Parameters:
| id | The contact's id |
| delObj | True to delete the object if found |
Returns: ClientContact pointer if found and not deleted or 0
| Message* userlogin (bool login, const char* msg = "user.login")
| userlogin |
[virtual]
Build a login/logout message from account's data
Parameters:
| login | True to login, false to logout |
| msg | Optional message name. Default to 'user.login' |
Returns: A valid Message pointer
| void buildAccountId (URI& dest, const char* proto, const char* user, const char* host)
| buildAccountId |
[static]
Build an account id
Parameters:
| dest | Destination URI |
| proto | The account's protocol |
| user | The account's username |
| host | The account's host |
| String m_password | m_password |
| String m_server | m_server |
| int m_port | m_port |
| String m_options | m_options |
| bool m_startup | m_startup |
| String m_outbound | m_outbound |
| int m_expires | m_expires |
| bool m_connected | m_connected |
| void destroyed ()
| destroyed |
[protected virtual]
Reimplemented from RefObject.
| void appendContact (ClientContact* contact)
| appendContact |
[protected virtual]
| inline void setIdUri (const char* proto, const char* user,
const char* host)
| setIdUri |
[protected]
| URI m_id | m_id |
[protected]
| URI m_uri | m_uri |
[protected]
| ClientResource* m_resource | m_resource |
[protected]
| ObjList m_contacts | m_contacts |
[protected]
| Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54. |