OssoABookAccountManager

typedef struct _OssoABookAccountManager OssoABookAccountManager;

All the fields of this structure are private to the object's implementation and should never be accessed directly.

osso_abook_account_manager_get_default ()

OssoABookAccountManager* osso_abook_account_manager_get_default
                                                        (void);

Retrieve the default OssoABookAccountManager.

osso_abook_account_manager_new ()

OssoABookAccountManager* osso_abook_account_manager_new (void);

Creates a new OssoABookAccountManager instance.

osso_abook_account_manager_get_dbus_daemon ()

TpDBusDaemon*       osso_abook_account_manager_get_dbus_daemon
                                                        (OssoABookAccountManager *manager);

Retrieves the TpDBusDaemon object used when this OssoABookAccountManager communicates with Telepathy or Mission Control.

osso_abook_account_manager_get_presence ()

TpConnectionPresenceType osso_abook_account_manager_get_presence
                                                        (OssoABookAccountManager *manager);

Queries the current value of the "presence" property.

osso_abook_account_manager_set_active_accounts_only ()

void                osso_abook_account_manager_set_active_accounts_only
                                                        (OssoABookAccountManager *manager,
                                                         gboolean setting);

Changes the current value of the "active-accounts-only" property.

osso_abook_account_manager_is_active_accounts_only ()

gboolean            osso_abook_account_manager_is_active_accounts_only
                                                        (OssoABookAccountManager *manager);

Queries the current value of the "active-accounts-only" property.

osso_abook_account_manager_set_allowed_accounts ()

void                osso_abook_account_manager_set_allowed_accounts
                                                        (OssoABookAccountManager *manager,
                                                         GList *accounts);

Sets the value of the "allowed-accounts" property, which is the list of allowed accounts that the manager is being filtered by.

The manager copies accounts (but not the elements), so you must free the list after calling this function.

osso_abook_account_manager_get_allowed_accounts ()

GList*              osso_abook_account_manager_get_allowed_accounts
                                                        (OssoABookAccountManager *manager);

Retrieves the current value of the "allowed-accounts" property, which is the list of allowed accounts that the manager is being filtered by.

This list is owned by the manager and it and its elements must not be freed.

osso_abook_account_manager_set_allowed_capabilities ()

void                osso_abook_account_manager_set_allowed_capabilities
                                                        (OssoABookAccountManager *manager,
                                                         OssoABookCapsFlags caps);

Changes the current value of the "allowed-capabilities" property.

osso_abook_account_manager_get_allowed_capabilities ()

OssoABookCapsFlags  osso_abook_account_manager_get_allowed_capabilities
                                                        (OssoABookAccountManager *manager);

Queries the current value of the "allowed-capabilities" property.

osso_abook_account_manager_set_required_capabilities ()

void                osso_abook_account_manager_set_required_capabilities
                                                        (OssoABookAccountManager *manager,
                                                         OssoABookCapsFlags caps);

Changes the current value of the "required-capabilities" property.

osso_abook_account_manager_get_required_capabilities ()

OssoABookCapsFlags  osso_abook_account_manager_get_required_capabilities
                                                        (OssoABookAccountManager *manager);

Queries the current value of the "required-capabilities" property.

osso_abook_account_manager_set_account_protocol ()

void                osso_abook_account_manager_set_account_protocol
                                                        (OssoABookAccountManager *manager,
                                                         const char *protocol);

Changes the current value of the "account-protocol" property.

osso_abook_account_manager_get_account_protocol ()

const char*         osso_abook_account_manager_get_account_protocol
                                                        (OssoABookAccountManager *manager);

Queries the current value of the "account-protocol" property.

osso_abook_account_manager_lookup_by_name ()

McAccount*          osso_abook_account_manager_lookup_by_name
                                                        (OssoABookAccountManager *manager,
                                                         const char *name);

Finds the McAccount with the given unique name.

osso_abook_account_manager_lookup_by_vcard_field ()

McAccount*          osso_abook_account_manager_lookup_by_vcard_field
                                                        (OssoABookAccountManager *manager,
                                                         const char *vcard_field,
                                                         const char *vcard_value);

Finds the McAccount which can be used to contact the communication handle described by vcard_field and vcard_value.

osso_abook_account_manager_list_accounts ()

GList*              osso_abook_account_manager_list_accounts
                                                        (OssoABookAccountManager *manager,
                                                         McAccountFilterFunc filter,
                                                         gpointer user_data);

Lists all McAccount known by this OssoABookAccountManager. The list of returned contacts can be limited by passing a filter function.

osso_abook_account_manager_list_enabled_accounts ()

GList*              osso_abook_account_manager_list_enabled_accounts
                                                        (OssoABookAccountManager *manager);

Lists all currently enabled McAccount this OssoABookAccountManager knows.

osso_abook_account_manager_list_by_profile ()

GList*              osso_abook_account_manager_list_by_profile
                                                        (OssoABookAccountManager *manager,
                                                         const char *profile_id);

Lists all currently known account backed by the Mission Control profile identified by profile_id.

osso_abook_account_manager_list_by_vcard_field ()

GList*              osso_abook_account_manager_list_by_vcard_field
                                                        (OssoABookAccountManager *manager,
                                                         const char *vcard_field);

Lists all currently known account supporting the requested vcard_field as preferred communication method.

osso_abook_account_manager_list_by_secondary_vcard_field ()

GList*              osso_abook_account_manager_list_by_secondary_vcard_field
                                                        (OssoABookAccountManager *manager,
                                                         const char *vcard_field);

Lists all currently known account supporting the requested vcard_field as additional communication method.

osso_abook_account_manager_get_primary_vcard_fields ()

const GList*        osso_abook_account_manager_get_primary_vcard_fields
                                                        (OssoABookAccountManager *manager);

Lists the vCard fields for all preferred communication method supported by the currently known Mission Control accounts.

osso_abook_account_manager_has_primary_vcard_field ()

gboolean            osso_abook_account_manager_has_primary_vcard_field
                                                        (OssoABookAccountManager *manager,
                                                         const char *vcard_field);

Checks if there is a Mission Control account which prefers the communication method described by vcard_field.

osso_abook_account_manager_get_secondary_vcard_fields ()

const GList*        osso_abook_account_manager_get_secondary_vcard_fields
                                                        (OssoABookAccountManager *manager);

Lists the vCard fields for all additional communication methods currently known Mission Control accounts.

osso_abook_account_manager_has_secondary_vcard_field ()

gboolean            osso_abook_account_manager_has_secondary_vcard_field
                                                        (OssoABookAccountManager *manager,
                                                         const char *vcard_field);

Checks if there is a Mission Control account which also supports the communication method described by vcard_field.

osso_abook_account_manager_get_vcard_field ()

const char*         osso_abook_account_manager_get_vcard_field
                                                        (OssoABookAccountManager *manager,
                                                         const char *account_name);

Gets the name of the vcard field associated with account_name

osso_abook_account_manager_list_profiles ()

GList*              osso_abook_account_manager_list_profiles
                                                        (OssoABookAccountManager *manager,
                                                         const gchar *attr_name,
                                                         gboolean no_roster_only);

List all account profiles whose vCard field matches attr_name. If no_roster_only is TRUE, the list will be limited to only those account profiles that don't support rosters.

osso_abook_account_manager_call_when_ready ()

void                osso_abook_account_manager_call_when_ready
                                                        (OssoABookAccountManager *manager,
                                                         OssoABookAccountManagerReadyCallbackcallback ,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy);

Registers callback as a function to be called when manager becomes ready. See osso_abook_waitable_call_when_ready() for more details.

osso_abook_account_manager_wait_until_ready ()

void                osso_abook_account_manager_wait_until_ready
                                                        (OssoABookAccountManager *manager,
                                                         GMainContext *context,
                                                         GError **error);

Spins a main loop until manager is ready. See osso_abook_waitable_run() for more details.

osso_abook_account_manager_set_roster_query ()

void                osso_abook_account_manager_set_roster_query
                                                        (OssoABookAccountManager *manager,
                                                         EBookQuery *query);

This function can be used to restrict the contacts reported by the rosters the manager creates for its accounts when acting as OssoABookRosterManager.

For instance if you are just interested in contacts with birthday field, the following setup could be used:

manager = osso_abook_account_manager_new ();
query = e_book_query_vcard_field_exists (EVC_BDAY);
osso_abook_account_manager_set_roster_query (manager, query);

aggregator = osso_abook_aggregator_new_with_query (NULL, query, NULL, 0, NULL);
osso_abook_aggregator_set_roster_manager (OSSO_ABOOK_AGGREGATOR (aggregator), manager);

e_book_query_unref (query);

The "account-protocol" property

  "account-protocol"         gchar*                : Read / Write / Construct

Accepted account protocol (NULL for all protocols).

Default value: NULL

The "active-accounts-only" property

  "active-accounts-only"     gboolean              : Read / Write / Construct

Don't report accounts which are disabled.

Default value: TRUE

The "allowed-accounts" property

  "allowed-accounts"         gpointer              : Read / Write / Construct

Accounts which may appear in the model (if all additional filters allow them).

The "allowed-capabilities" property

  "allowed-capabilities"     OssoABookCapsFlags    : Read / Write / Construct

Set of of accepted account capabilities.

Default value: OSSO_ABOOK_CAPS_EMAIL|OSSO_ABOOK_CAPS_CHAT|OSSO_ABOOK_CAPS_CHAT_ADDITIONAL|OSSO_ABOOK_CAPS_VOICE|OSSO_ABOOK_CAPS_VOICE_ADDITIONAL|OSSO_ABOOK_CAPS_VIDEO|OSSO_ABOOK_CAPS_PHONE|OSSO_ABOOK_CAPS_ADDRESSBOOK|OSSO_ABOOK_CAPS_SMS

The "presence" property

  "presence"                 guint                 : Read

Current presence status of this session.

Default value: 0

The "required-capabilities" property

  "required-capabilities"    OssoABookCapsFlags    : Read / Write / Construct

Set of of required account capabilities.

The "account-changed" signal

void                user_function                      (OssoABookAccountManager *manager,
                                                        McAccount               *account,
                                                        guint                    property,
                                                        GValue                  *value,
                                                        gpointer                 user_data)      : Run First / Has Details

This signal is emitted when some account property changes.

The "account-created" signal

void                user_function                      (OssoABookAccountManager *manager,
                                                        McAccount               *account,
                                                        gpointer                 user_data)      : Run First

This signal is emitted when a account is added to Mission Control.

The "account-removed" signal

void                user_function                      (OssoABookAccountManager *manager,
                                                        McAccount               *account,
                                                        gpointer                 user_data)      : Run Last

This signal is emitted when a account is removed from Mission Control.