enum OssoABookAggregatorState

typedef enum {
        OSSO_ABOOK_AGGREGATOR_PENDING       = (0),
        OSSO_ABOOK_AGGREGATOR_RUNNING       = (1 << 0),
        OSSO_ABOOK_AGGREGATOR_MASTERS_READY = (1 << 1),
        OSSO_ABOOK_AGGREGATOR_ROSTERS_READY = (1 << 2),
        OSSO_ABOOK_AGGREGATOR_READY         = (OSSO_ABOOK_AGGREGATOR_MASTERS_READY | OSSO_ABOOK_AGGREGATOR_ROSTERS_READY),
} OssoABookAggregatorState;

OssoABookContactPredicate ()

gboolean            (*OssoABookContactPredicate)        (OssoABookContact *contact,
                                                         gpointer user_data);

OssoABookAggregator

typedef struct _OssoABookAggregator OssoABookAggregator;

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

osso_abook_aggregator_new ()

OssoABookRoster*    osso_abook_aggregator_new           (EBook *book,
                                                         GError **error);

Creates a new OssoABookAggregator on top of book.

osso_abook_aggregator_new_with_query ()

OssoABookRoster*    osso_abook_aggregator_new_with_query
                                                        (EBook *book,
                                                         EBookQuery *query,
                                                         GList *requested_fields,
                                                         int max_results,
                                                         GError **error);

Creates a new OssoABookAggregator on top of book, but only contacts matching the query are considered.

osso_abook_aggregator_new_with_view ()

OssoABookRoster*    osso_abook_aggregator_new_with_view (EBookView *view);

Creates a new OssoABookAggregator on top of view. Usually it is more reasonable to call osso_abook_aggregator_new_with_query() or osso_abook_aggregator_new(), since those functions take care of the burden to open the EBook and the EBookView asynchroniously.

osso_abook_aggregator_get_default ()

OssoABookRoster*    osso_abook_aggregator_get_default   (GError **error);

osso_abook_aggregator_get_state ()

OssoABookAggregatorState osso_abook_aggregator_get_state
                                                        (OssoABookAggregator *aggregator);

osso_abook_aggregator_lookup ()

GList*              osso_abook_aggregator_lookup        (OssoABookAggregator *aggregator,
                                                         const char *uid);

Lists all master contacts currently known by the aggregator and matching the requested uid. When uid directly matches a master contact, only this contact is returned. When uid matches an attached roster contact all of its master contacts are returned.

osso_abook_aggregator_get_master_contact_count ()

unsigned            osso_abook_aggregator_get_master_contact_count
                                                        (OssoABookAggregator *aggregator);

osso_abook_aggregator_get_roster_manager ()

OssoABookRosterManager* osso_abook_aggregator_get_roster_manager
                                                        (OssoABookAggregator *aggregator);

Retrieves the current value of the "roster-manager" property.

osso_abook_aggregator_set_roster_manager ()

void                osso_abook_aggregator_set_roster_manager
                                                        (OssoABookAggregator *aggregator,
                                                         OssoABookRosterManager *manager);

Changes the value of the "roster-manager" property.

osso_abook_aggregator_add_filter ()

void                osso_abook_aggregator_add_filter    (OssoABookAggregator *aggregator,
                                                         OssoABookContactFilter *filter);

Adds another contact filter to the aggregator. Master contacts will not show up unless they are accepted by all filters. The aggregator will synthesize "contacts-remove" signals when the new filter rejects currently visible contacts.

osso_abook_aggregator_remove_filter ()

void                osso_abook_aggregator_remove_filter (OssoABookAggregator *aggregator,
                                                         OssoABookContactFilter *filter);

Removes a contact filter from the aggregator. Master contacts will not show up unless they are accepted by all filters. The aggregator will synthesize "contacts-added" signals when the filter was the last one rejecting certain contacts.

The "master-contact-count" property

  "master-contact-count"     guint                 : Read

Current number of master contacts in the aggregator.

Default value: 0

The "roster-manager" property

  "roster-manager"           OssoABookRosterManager*  : Read / Write

The OssoABookRosterManager informing this aggregator about new and removed rosters.

The "state" property

  "state"                    OssoABookAggregatorState  : Read

Current state of the aggregator.

The "ebook-status" signal

gboolean            user_function                      (OssoABookAggregator *aggregator,
                                                        guint                status,
                                                        gpointer             user_data)       : Run Last

This signal reports the EBookStatus that is returned when opening the EBook passed to osso_abook_aggregator_new

The "roster-sequence-complete" signal

void                user_function                      (OssoABookAggregator *aggregator,
                                                        OssoABookRoster     *roster,
                                                        guint                status,
                                                        gpointer             user_data)       : Run Last

This signal is emitted when on of the underlying rosters reports that there are currently no more contacts to send. It is emitted once after the initial set of "contacts-added" signals, and after every future change.

See also: "sequence-complete"

The "temporary-contact-saved" signal

void                user_function                      (OssoABookAggregator *aggregator,
                                                        gchar               *temporary_uid,
                                                        GObject             *persistent,
                                                        gpointer             user_data)          : Run First

This signal is emitted when a temporary master contact was saved and turned into a regular master contact.