OssoABookContactDetailStore

OssoABookContactDetailStore — Store containing contact's details.

Synopsis

                    OssoABookContactDetailStore;
enum                OssoABookContactDetailFilters;
#define             OSSO_ABOOK_CONTACT_DETAIL_CALL
OssoABookContactDetailStore* osso_abook_contact_detail_store_new
                                                        (OssoABookContact *contact,
                                                         OssoABookContactDetailFilters filters);
GHashTable*         osso_abook_contact_detail_store_get_message_map
                                                        (OssoABookContactDetailStore *self);
void                osso_abook_contact_detail_store_set_message_map
                                                        (OssoABookContactDetailStore *self,
                                                         const OssoABookMessageMapping *message_map);
OssoABookContact*   osso_abook_contact_detail_store_get_contact
                                                        (OssoABookContactDetailStore *self);
void                osso_abook_contact_detail_store_set_contact
                                                        (OssoABookContactDetailStore *self,
                                                         OssoABookContact *contact);
void                osso_abook_contact_detail_store_set_filters
                                                        (OssoABookContactDetailStore *self,
                                                         OssoABookContactDetailFilters filters);
GSequence*          osso_abook_contact_detail_store_get_fields
                                                        (OssoABookContactDetailStore *self);
gboolean            osso_abook_contact_detail_store_is_empty
                                                        (OssoABookContactDetailStore *self);

Object Hierarchy

  GObject
   +----OssoABookContactDetailStore

Properties

  "contact"                  OssoABookContact*     : Read / Write / Construct
  "filters"                  OssoABookContactDetailFilters  : Read / Write / Construct
  "message-map"              GHashTable*           : Read / Write / Construct

Signals

  "changed"                                        : Run Last
  "contact-changed"                                : Run Last

Description

Details

OssoABookContactDetailStore

typedef struct _OssoABookContactDetailStore OssoABookContactDetailStore;

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


enum OssoABookContactDetailFilters

typedef enum {
        OSSO_ABOOK_CONTACT_DETAIL_NONE     = 0,
        OSSO_ABOOK_CONTACT_DETAIL_EMAIL    = 1 << 0,
        OSSO_ABOOK_CONTACT_DETAIL_PHONE    = 1 << 1,
        OSSO_ABOOK_CONTACT_DETAIL_IM_VOICE = 1 << 2,
        OSSO_ABOOK_CONTACT_DETAIL_IM_VIDEO = 1 << 3,
        OSSO_ABOOK_CONTACT_DETAIL_IM_CHAT  = 1 << 4,
        OSSO_ABOOK_CONTACT_DETAIL_FULLNAME = 1 << 5,
        OSSO_ABOOK_CONTACT_DETAIL_NICKNAME = 1 << 6,
        OSSO_ABOOK_CONTACT_DETAIL_OTHERS   = 1 << 7,
        OSSO_ABOOK_CONTACT_DETAIL_ALL      = (1 << 8) - 1,
} OssoABookContactDetailFilters;

Flags to specify filters for the details in the OssoABookContactDetailStore

OSSO_ABOOK_CONTACT_DETAIL_NONE No filters
OSSO_ABOOK_CONTACT_DETAIL_EMAIL match email details
OSSO_ABOOK_CONTACT_DETAIL_PHONE match telephone details
OSSO_ABOOK_CONTACT_DETAIL_IM_VOICE match IM accounts with audio capability
OSSO_ABOOK_CONTACT_DETAIL_IM_VIDEO match IM accounts with video capability
OSSO_ABOOK_CONTACT_DETAIL_IM_CHAT match IM accounts with text chat capability
OSSO_ABOOK_CONTACT_DETAIL_FULLNAME match fullname detail
OSSO_ABOOK_CONTACT_DETAIL_NICKNAME match nickname detail
OSSO_ABOOK_CONTACT_DETAIL_OTHERS match all other details
OSSO_ABOOK_CONTACT_DETAIL_ALL match all details

OSSO_ABOOK_CONTACT_DETAIL_CALL

#define             OSSO_ABOOK_CONTACT_DETAIL_CALL

A filter mask for any type of call, either telephone or VoIP (audio or video)


osso_abook_contact_detail_store_new ()

OssoABookContactDetailStore* osso_abook_contact_detail_store_new
                                                        (OssoABookContact *contact,
                                                         OssoABookContactDetailFilters filters);

Creates a new OssoABookContactDetailStore object.

contact : The contact from which we need to expose information
filters : a bitmask specifying which details to expose
Returns : A new OssoABookContactDetailStore object.

osso_abook_contact_detail_store_get_message_map ()

GHashTable*         osso_abook_contact_detail_store_get_message_map
                                                        (OssoABookContactDetailStore *self);

Gets the mapping of generic message ids to contextual ids

self : a OssoABookContactDetailStore
Returns : a message map, owned by self

osso_abook_contact_detail_store_set_message_map ()

void                osso_abook_contact_detail_store_set_message_map
                                                        (OssoABookContactDetailStore *self,
                                                         const OssoABookMessageMapping *message_map);

Sets a new message map for self

self : a OssoABookContactDetailStore
message_map : a mapping from generic message ids to contextual ids

osso_abook_contact_detail_store_get_contact ()

OssoABookContact*   osso_abook_contact_detail_store_get_contact
                                                        (OssoABookContactDetailStore *self);

Gets the contact that provides the details for self

self : a OssoABookContactDetailStore
Returns : the backing contact, owned by self

osso_abook_contact_detail_store_set_contact ()

void                osso_abook_contact_detail_store_set_contact
                                                        (OssoABookContactDetailStore *self,
                                                         OssoABookContact *contact);

Sets contact as the source for the details of self

self : a OssoABookContactDetailStore
contact : a new value for the backing contact

osso_abook_contact_detail_store_set_filters ()

void                osso_abook_contact_detail_store_set_filters
                                                        (OssoABookContactDetailStore *self,
                                                         OssoABookContactDetailFilters filters);

Sets new filters for self

self : the OssoABookContactDetailStore
filters : new filter bitmask for the details

osso_abook_contact_detail_store_get_fields ()

GSequence*          osso_abook_contact_detail_store_get_fields
                                                        (OssoABookContactDetailStore *self);

Gets a filtered list of detail fields.

self : the OssoABookContactDetailStore
Returns : a GSequence of OssoABookContactFields, owned by self

osso_abook_contact_detail_store_is_empty ()

gboolean            osso_abook_contact_detail_store_is_empty
                                                        (OssoABookContactDetailStore *self);

Checks whether self is empty

self : a OssoABookContactDetailStore
Returns : TRUE if self is empty, else FALSE

Property Details

The "contact" property

  "contact"                  OssoABookContact*     : Read / Write / Construct

The contact of which to show details.


The "filters" property

  "filters"                  OssoABookContactDetailFilters  : Read / Write / Construct

The contact field filters to use.


The "message-map" property

  "message-map"              GHashTable*           : Read / Write / Construct

Mapping for generic message ids to context ids.

Signal Details

The "changed" signal

void                user_function                      (OssoABookContactDetailStore *detail_store,
                                                        gpointer                     user_data)         : Run Last

This signal is emitted when the contents of detail_store change.

detail_store : a OssoABookContactDetailStore
user_data : user data set when the signal handler was connected.

The "contact-changed" signal

void                user_function                      (OssoABookContactDetailStore *detail_store,
                                                        OssoABookContact            *old_contact,
                                                        OssoABookContact            *new_contact,
                                                        gpointer                     user_data)         : Run Last

This signal is emitted when a new contact is set for this detail store. It provides the old and new contacts as arguments.

detail_store : a OssoABookContactDetailStore
old_contact : the old OssoABookContact associated with this OssoABookContactDetailStore
new_contact : the new OssoABookContact associated with this OssoABookContactDetailStore
user_data : user data set when the signal handler was connected.