Yate
|
A client account list. More...
#include <yatecbase.h>
Public Member Functions | |
ClientAccountList (const char *name, ClientAccount *localContacts=0) | |
~ClientAccountList () | |
ObjList & | accounts () |
ClientAccount * | localContacts () const |
bool | isLocalContact (ClientContact *c) const |
bool | isLocalContact (const String &id) const |
virtual ClientAccount * | findAccount (const String &id, bool ref=false) |
virtual ClientContact * | findContactByUri (const String &account, const String &uri, bool ref=false) |
virtual ClientContact * | findContact (const String &account, const String &id, bool ref=false) |
virtual ClientContact * | findContact (const String &builtId, bool ref=false) |
virtual ClientContact * | findContactByInstance (const String &id, String *instance=0, bool ref=false) |
virtual MucRoom * | findRoom (const String &id, bool ref=false) |
virtual MucRoom * | findRoomByMember (const String &id, bool ref=false) |
virtual ClientContact * | findAnyContact (const String &id, bool ref=false) |
virtual ClientAccount * | findSingleRegAccount (const String *skipProto=0, bool ref=false) |
virtual bool | appendAccount (ClientAccount *account) |
virtual void | removeAccount (const String &id) |
Protected Attributes | |
ObjList | m_accounts |
A client account list.
This class holds an account list
ClientAccountList | ( | const char * | name, |
ClientAccount * | localContacts = 0 |
||
) | [inline, explicit] |
Constructor
name | List's name used for debug purposes |
localContacts | Optional account owning locally stored contacts |
~ClientAccountList | ( | ) |
Destructor
virtual bool appendAccount | ( | ClientAccount * | account | ) | [virtual] |
Append a new account. The account's reference counter is increased before
account | The account to append |
virtual ClientAccount* findAccount | ( | const String & | id, |
bool | ref = false |
||
) | [virtual] |
Find an account
id | The account's id |
ref | True to get a referenced pointer |
virtual ClientContact* findAnyContact | ( | const String & | id, |
bool | ref = false |
||
) | [virtual] |
Find any contact (regular or MUC room) by its id
id | The id of the desired contact |
ref | True to obtain a referenced pointer |
virtual ClientContact* findContact | ( | const String & | account, |
const String & | id, | ||
bool | ref = false |
||
) | [virtual] |
Find an account's contact
account | The account's id |
id | The contact's id |
ref | True to get a referenced pointer |
virtual ClientContact* findContact | ( | const String & | builtId, |
bool | ref = false |
||
) | [virtual] |
Find an account's contact from a built id
builtId | The string containign the account and the contact |
ref | True to get a referenced pointer |
virtual ClientContact* findContactByInstance | ( | const String & | id, |
String * | instance = 0 , |
||
bool | ref = false |
||
) | [virtual] |
Find a contact an instance id
id | The id |
instance | Optional pointer to String to be filled with instance id |
ref | True to get a referenced pointer |
virtual ClientContact* findContactByUri | ( | const String & | account, |
const String & | uri, | ||
bool | ref = false |
||
) | [virtual] |
Find an account's contact by its URI (build an id from account and uri)
account | The account's id |
uri | The contact's uri |
ref | True to get a referenced pointer |
Find a MUC room by its id
id | Room id |
ref | True to obtain a referenced pointer |
virtual MucRoom* findRoomByMember | ( | const String & | id, |
bool | ref = false |
||
) | [virtual] |
Find a MUC room by member id
id | Room member id |
ref | True to obtain a referenced pointer |
virtual ClientAccount* findSingleRegAccount | ( | const String * | skipProto = 0 , |
bool | ref = false |
||
) | [virtual] |
Check if there is a single registered account and return it
skipProto | Optional account protocol to skip |
ref | True to get a referenced pointer |
bool isLocalContact | ( | ClientContact * | c | ) | const |
Check if a contact is locally stored
c | The contact to check |
bool isLocalContact | ( | const String & | id | ) | const [inline] |
Check if a contact is locally stored
id | Contact id to check |
ClientAccount* localContacts | ( | ) | const [inline] |
Retrieve the account owning locally stored contacts
virtual void removeAccount | ( | const String & | id | ) | [virtual] |
Remove an account
id | The account's id |