OSSO_ABOOK_VCA_GENDER

#define OSSO_ABOOK_VCA_GENDER          "X-GENDER"

VCard attribute name for storing the gender.

OSSO_ABOOK_VCA_OSSO_MASTER_UID

#define OSSO_ABOOK_VCA_OSSO_MASTER_UID          "X-OSSO-MASTER-UID"

VCard attribute name for storing the set of master contact UIDs.

OSSO_ABOOK_VCA_TELEPATHY_HANDLE

#define OSSO_ABOOK_VCA_TELEPATHY_HANDLE         "X-TELEPATHY-HANDLE"

VCard attribute name for reporting the contact's Telepathy handle.

OSSO_ABOOK_VCA_TELEPATHY_PRESENCE

#define OSSO_ABOOK_VCA_TELEPATHY_PRESENCE       "X-TELEPATHY-PRESENCE"

VCard attribute name for reporting the contact's presence state. Valid values: [detailed-name;]{available,away,...}[;custom-message]

OSSO_ABOOK_VCA_TELEPATHY_CAPABILITIES

#define OSSO_ABOOK_VCA_TELEPATHY_CAPABILITIES   "X-TELEPATHY-CAPABILITIES"

VCard attribute name for reporting the contact's communication capabilities. Valid values: {text,audio,video}*

OSSO_ABOOK_VCA_TELEPATHY_BLOCKED

#define OSSO_ABOOK_VCA_TELEPATHY_BLOCKED        "X-TELEPATHY-BLOCKED"

VCard attribute name for reporting the contact's blocking state. Valid values: yes, no, local-pending, remote-pending

OSSO_ABOOK_VCA_TELEPATHY_SUBSCRIBED

#define OSSO_ABOOK_VCA_TELEPATHY_SUBSCRIBED     "X-TELEPATHY-SUBSCRIBED"

VCard attribute name for reporting the contact's subscription state. Valid values: yes, no, local-pending, remote-pending

OSSO_ABOOK_VCA_TELEPATHY_PUBLISHED

#define OSSO_ABOOK_VCA_TELEPATHY_PUBLISHED      "X-TELEPATHY-PUBLISHED"

VCard attribute name for reporting the contact's publication state. Valid values: yes, no, local-pending, remote-pending

OSSO_ABOOK_VCP_OSSO_READONLY

#define OSSO_ABOOK_VCP_OSSO_READONLY            "X-OSSO-READONLY"

This paramter marks a vCard attribute as read-only. Valid values: yes, no

OSSO_ABOOK_VCP_OSSO_VALID

#define OSSO_ABOOK_VCP_OSSO_VALID               "X-OSSO-VALID"

VCard parameter name for marking an attribute as known-invalid (eg, after confirming with the server that a username is invalid/missing). Valid values: yes, no, <parameter missing> (validity unconfirmed)

OSSO_ABOOK_VCP_OSSO_VARIANTS

#define OSSO_ABOOK_VCP_OSSO_VARIANTS            "X-OSSO-VARIANTS"

VCard parameter name for adding alternate versions of the same user name as the real user name can be different to the one inserted by the user as normalization can happen.

OSSO_ABOOK_DTMF_CHARS

#define OSSO_ABOOK_DTMF_CHARS                   "PpWwXx"

Set of characters starting a DTMF sequence.

OSSO_ABOOK_HOME_APPLET_PREFIX

#define OSSO_ABOOK_HOME_APPLET_PREFIX           "osso-abook-applet-"

enum OssoABookContactAction

typedef enum {
        OSSO_ABOOK_CONTACT_ACTION_NONE,
        OSSO_ABOOK_CONTACT_ACTION_TEL,
        OSSO_ABOOK_CONTACT_ACTION_SMS,
        OSSO_ABOOK_CONTACT_ACTION_CHATTO,
        OSSO_ABOOK_CONTACT_ACTION_VOIPTO,
        OSSO_ABOOK_CONTACT_ACTION_VOIPTO_AUDIO,
        OSSO_ABOOK_CONTACT_ACTION_VOIPTO_VIDEO,
        OSSO_ABOOK_CONTACT_ACTION_DATE,
        OSSO_ABOOK_CONTACT_ACTION_MAILTO,
        OSSO_ABOOK_CONTACT_ACTION_MAP,
        OSSO_ABOOK_CONTACT_ACTION_URL,
        OSSO_ABOOK_CONTACT_ACTION_CREATE_ACCOUNT,
        OSSO_ABOOK_CONTACT_ACTION_BIND,
        OSSO_ABOOK_CONTACT_ACTION_CHATTO_ERROR,
        OSSO_ABOOK_CONTACT_ACTION_VOIPTO_ERROR,
} OssoABookContactAction;

OSSO_ABOOK_CONTACT_ACTION_NONE: no actions supported OSSO_ABOOK_CONTACT_ACTION_TEL: Start a telephone call OSSO_ABOOK_CONTACT_ACTION_SMS: Send an SMS message OSSO_ABOOK_CONTACT_ACTION_CHATTO: Start a text chat OSSO_ABOOK_CONTACT_ACTION_VOIPTO: Start a VoIP call OSSO_ABOOK_CONTACT_ACTION_VOIPTO_AUDIO: Start a VoIP audio call OSSO_ABOOK_CONTACT_ACTION_VOIPTO_VIDEO: Start a VoIP video call OSSO_ABOOK_CONTACT_ACTION_DATE: Open a date in the calendar OSSO_ABOOK_CONTACT_ACTION_MAILTO: Send an email OSSO_ABOOK_CONTACT_ACTION_MAP: Open location in map application OSSO_ABOOK_CONTACT_ACTION_URL: Open URL in the browser OSSO_ABOOK_CONTACT_ACTION_CREATE_ACCOUNT: create an IM or VoIP account OSSO_ABOOK_CONTACT_ACTION_BIND: binding an IM or VoIP username to an existing account OSSO_ABOOK_CONTACT_ACTION_CHATTO_ERROR: Display an error for invalid IM username OSSO_ABOOK_CONTACT_ACTION_VOIPTO_ERROR: Display an error for invalid VoIP username

Actions that are supported by different fields of an OssoABookContact

OssoABookContactWriteToFileCb ()

void                (*OssoABookContactWriteToFileCb)    (OssoABookContact *contact,
                                                         GFile *file,
                                                         const GError *error,
                                                         gpointer user_data);

A function that will be called when osso_abook_contact_write_to_file() is complete

OssoABookContactActionStartCb ()

void                (*OssoABookContactActionStartCb)    (const GError *error,
                                                         GtkWindow *parent,
                                                         gpointer user_data);

A function that will be called after an action has been started to report the status of the action

enum OssoABookContactActionError

typedef enum {
        OSSO_ABOOK_CONTACT_ACTION_ERROR_SUCCESS,
        OSSO_ABOOK_CONTACT_ACTION_ERROR_ADDRESS,
} OssoABookContactActionError;

OssoABookContact

typedef struct _OssoABookContact OssoABookContact;

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

osso_abook_contact_new ()

OssoABookContact*   osso_abook_contact_new              (void);

Create a new and still empty OssoABookContact.

osso_abook_contact_new_from_template ()

OssoABookContact*   osso_abook_contact_new_from_template
                                                        (EContact *templ);

Create a new and initializes its attributes to match templ.

osso_abook_contact_new_from_vcard ()

OssoABookContact*   osso_abook_contact_new_from_vcard   (const char *uid,
                                                         const char *vcard);

Create a new and initializes to have the attributes described in vcard. The vcard string is not parsed unless another attribute but the UID attribute is required.

osso_abook_contact_get_persistent_uid ()

const char*         osso_abook_contact_get_persistent_uid
                                                        (OssoABookContact *contact);

Retrieves the persistent UID of this contact which should be stored in databases and such.

osso_abook_contact_get_value ()

char*               osso_abook_contact_get_value        (EContact *contact,
                                                         const char *attr_name);

Retrieves the value of the named single-value attribute, when found.

osso_abook_contact_get_values ()

GList*              osso_abook_contact_get_values       (EContact *contact,
                                                         const char *attr_name);

Retrieves the value list for the first attribute matching attr_name.

osso_abook_contact_get_attributes ()

GList*              osso_abook_contact_get_attributes   (EContact *contact,
                                                         const char *attr_name);

Retrieves the list of attributes with a name matching attr_name.

osso_abook_contact_set_value ()

void                osso_abook_contact_set_value        (EContact *contact,
                                                         const char *attr_name,
                                                         const char *value);

Changes the value of the named single-value attribute. Passing a value of NULL removes the attribute.

osso_abook_contact_add_value ()

gboolean            osso_abook_contact_add_value        (EContact *contact,
                                                         const char *attr_name,
                                                         GCompareFunc value_check,
                                                         const char *value);

Adds a new value to the attribute matching attr_name. If value_check is non-NULL, it will be called to compare value to each of the existing values of the attribute. If value_check returns 0 for one of these comparisons, the value will not be added. This allows you to easily avoid adding duplicate values if desired.

osso_abook_contact_remove_value ()

void                osso_abook_contact_remove_value     (EContact *contact,
                                                         const char *attr_name,
                                                         const char *value);

Removes all occurrences of value from the value list of the attribute matching attr_name.

osso_abook_contact_find_matching_values ()

gboolean            osso_abook_contact_find_matching_values
                                                        (EContact *contact_a,
                                                         EContact *contact_b,
                                                         const char *attr_name,
                                                         GList **values);

osso_abook_contact_find_matching_attribute ()

EVCardAttribute*    osso_abook_contact_find_matching_attribute
                                                        (OssoABookContact *contact,
                                                         EVCardAttribute *attr,
                                                         gboolean fuzzy_match);

Checks if an attribute matching attr exists in contact and returns it. The returned attribute can be slightly different from attr as parameters are ignored and, if fuzzy_match is TRUE, the match is done in a fuzzy way, see osso_abook_attributes_match() for more details.

osso_abook_contact_reset ()

void                osso_abook_contact_reset            (OssoABookContact *contact,
                                                         OssoABookContact *replacement);

Remove all writable attributes from contact and replace them with the attributes specified in replacement

osso_abook_contact_attribute_set_readonly ()

void                osso_abook_contact_attribute_set_readonly
                                                        (EVCardAttribute *attribute,
                                                         gboolean readonly);

If readonly is TRUE, marks attribute as read-only, else marks it as writeable

osso_abook_contact_attribute_is_readonly ()

gboolean            osso_abook_contact_attribute_is_readonly
                                                        (EVCardAttribute *attribute);

Checks whether attribute is read-only or not

osso_abook_contact_attribute_set_profile ()

void                osso_abook_contact_attribute_set_profile
                                                        (EVCardAttribute *attribute,
                                                         const char *profile_name);

Associates a McProfile this vcard attribute.

osso_abook_contact_attribute_get_profile ()

McProfile*          osso_abook_contact_attribute_get_profile
                                                        (EVCardAttribute *attribute);

Find the McProfile associated with this vcard attribute. The returned object's reference count is incremented.

osso_abook_contact_attach ()

gboolean            osso_abook_contact_attach           (OssoABookContact *master_contact,
                                                         OssoABookContact *roster_contact);

Attaches a roster contact to some master contact, so that the master contact can utilize presence information from that roster contact to estimate its own presence state.

osso_abook_contact_detach ()

gboolean            osso_abook_contact_detach           (OssoABookContact *master_contact,
                                                         OssoABookContact *roster_contact);

Detaches a roster contact from some master contact, so that the master contact won't utilize presence information from that roster contact to estimate its own presence state anymore.

osso_abook_contact_has_roster_contacts ()

gboolean            osso_abook_contact_has_roster_contacts
                                                        (OssoABookContact *master_contact);

osso_abook_contact_get_roster_contacts ()

GList*              osso_abook_contact_get_roster_contacts
                                                        (OssoABookContact *master_contact);

Retrieves the current list of roster contacts attached to this master contact.

osso_abook_contact_find_roster_contacts ()

GList*              osso_abook_contact_find_roster_contacts
                                                        (OssoABookContact *master_contact,
                                                         const char *username,
                                                         const char *vcard_field);

Finds the roster contacts attached to this contact matching the passed account properties (user_name, vcard_field).

osso_abook_contact_find_roster_contacts_for_account ()

GList*              osso_abook_contact_find_roster_contacts_for_account
                                                        (OssoABookContact *master_contact,
                                                         const char *username,
                                                         const char *account_id);

Finds the roster contacts attached to this contact matching the passed account properties (user_name, account_id).

osso_abook_contact_find_roster_contacts_for_attribute ()

GList*              osso_abook_contact_find_roster_contacts_for_attribute
                                                        (OssoABookContact *master_contact,
                                                         EVCardAttribute *attribute);

Finds the roster contacts attached to this contact which match the specified attribute. For example, the following vcard field will match all roster contacts that have a google talk username of foobar.com: X-JABBER;TYPE="google-talk":foobar.com

See osso_abook_contact_real_find_roster_contacts() for more information about matching the vcard field.

osso_abook_create_temporary_uid ()

char*               osso_abook_create_temporary_uid     (void);

Creates a new temporary UID. The created UID is unique within this process.

osso_abook_is_temporary_uid ()

gboolean            osso_abook_is_temporary_uid         (const char *uid);

Checks if uid was generated by osso_abook_create_temporary_uid().

osso_abook_contact_get_master_uids ()

GList*              osso_abook_contact_get_master_uids  (OssoABookContact *roster_contact);

Retrieves the list of master contact's UID stored in this contact's OSSO_ABOOK_VCA_OSSO_MASTER_UID attribute.

osso_abook_contact_add_master_uid ()

gboolean            osso_abook_contact_add_master_uid   (OssoABookContact *roster_contact,
                                                         const char *master_uid);

Adds a master contact's UID to the OSSO_ABOOK_VCA_OSSO_MASTER_UID attribute of the contact.

osso_abook_contact_remove_master_uid ()

gboolean            osso_abook_contact_remove_master_uid
                                                        (OssoABookContact *roster_contact,
                                                         const char *master_uid);

Removes a master contact's UID from the OSSO_ABOOK_VCA_OSSO_MASTER_UID attribute of the contact.

osso_abook_contact_is_temporary ()

gboolean            osso_abook_contact_is_temporary     (OssoABookContact *contact);

Checks if the contact is a temporary contact which isn't stored in any addressbook yet.

osso_abook_contact_is_roster_contact ()

gboolean            osso_abook_contact_is_roster_contact
                                                        (OssoABookContact *contact);

Checks if the contact originates from some Telepathy based OssoABookRoster.

osso_abook_contact_is_sim_contact ()

gboolean            osso_abook_contact_is_sim_contact   (OssoABookContact *contact);

Checks if the contact originates from some SIM card.

osso_abook_contact_get_roster ()

OssoABookRoster*    osso_abook_contact_get_roster       (OssoABookContact *contact);

Queries the OssoABookRoster this contact comes from.

osso_abook_contact_get_account ()

McAccount*          osso_abook_contact_get_account      (OssoABookContact *contact);

Queries the McAccount this contact comes from.

osso_abook_contact_get_profile ()

McProfile*          osso_abook_contact_get_profile      (OssoABookContact *contact);

Queries the McProfile of the OssoABookRoster this contact comes from. The returned object's reference count is incremented.

osso_abook_contact_get_vcard_field ()

const char*         osso_abook_contact_get_vcard_field  (OssoABookContact *contact);

Queries the primary vCard attributes of the OssoABookRoster this contact comes from.

osso_abook_contact_get_bound_name ()

const char*         osso_abook_contact_get_bound_name   (OssoABookContact *contact);

Gets the bound name for contact. A bound name is a normalized version of the user-specified username for a contact.

osso_abook_contact_has_invalid_username ()

gboolean            osso_abook_contact_has_invalid_username
                                                        (OssoABookContact *contact);

osso_abook_contact_set_roster ()

void                osso_abook_contact_set_roster       (OssoABookContact *contact,
                                                         OssoABookRoster *roster);

Changes the OssoABookRoster this contact is supposed to come from.

osso_abook_contact_matches_phone_number ()

gboolean            osso_abook_contact_matches_phone_number
                                                        (OssoABookContact *contact,
                                                         const char *phone_number,
                                                         gboolean fuzzy_match);

Checks whether contact contains a phone number that matches phone_number. For details about fuzzy_match, see osso_abook_query_phone_number()

osso_abook_contact_matches_username ()

gboolean            osso_abook_contact_matches_username (OssoABookContact *contact,
                                                         const char *username,
                                                         const char *vcard_field,
                                                         const char *account_name);

Checks whether contact has a roster contact with the specified username. If vcard_field or account_name are non-NULL, it also checks whether the IM or VoIP account with that username also matches the vcard_field and account_name as well

osso_abook_contact_set_presence ()

void                osso_abook_contact_set_presence     (OssoABookContact *contact,
                                                         guint type,
                                                         const gchar *status,
                                                         const gchar *message);

Sets the presence for contact to the specified values. These parameters conform to the Telepathy SimplePresence specification. See the Simple_Presence type for more information.

osso_abook_contact_photo_is_user_selected ()

gboolean            osso_abook_contact_photo_is_user_selected
                                                        (OssoABookContact *contact);

osso_abook_contact_get_photo ()

GdkPixbuf*          osso_abook_contact_get_photo        (OssoABookContact *contact);

Fetches and returns the photo for a contact (as set in the PHOTO field).

osso_abook_contact_set_pixbuf ()

void                osso_abook_contact_set_pixbuf       (OssoABookContact *contact,
                                                         GdkPixbuf *pixbuf,
                                                         EBook *book,
                                                         GtkWindow *window);

Stores the image pointed to by pixbuf as contact's photo. If pixbuf is greater than OSSO_ABOOK_PIXEL_SIZE_AVATAR_LARGE, it will be scaled down. If pixbuf is NULL, contact's photo will be removed. When the contact is committed to the addressbook (e.g. book is non-NULL or osso_abook_contact_commit() is called), the pixbuf will be cached on disk.

osso_abook_contact_set_photo ()

void                osso_abook_contact_set_photo        (OssoABookContact *contact,
                                                         const char *filename,
                                                         EBook *book,
                                                         GtkWindow *window);

Loads the file specified by filename as a pixbuf at size OSSO_ABOOK_PIXEL_SIZE_AVATAR_DEFAULT and calls osso_abook_contact_set_pixbuf().

osso_abook_contact_set_photo_data ()

void                osso_abook_contact_set_photo_data   (OssoABookContact *contact,
                                                         gconstpointer data,
                                                         gsize len,
                                                         EBook *book,
                                                         GtkWindow *window);

Loads data into a GdkPixbuf and then calls osso_abook_contact_set_pixbuf().

osso_abook_contact_get_avatar ()

OssoABookAvatar*    osso_abook_contact_get_avatar       (OssoABookContact *contact,
                                                         const char *username,
                                                         const char *vcard_field);

Gets the OssoABookAvatar associated to contact, using username and vcard_field to select the specific account. You should use this function if you want to have notification for when the avatar image changes. If username or vcard_field are NULL, the returned object will monitor every account bound to contact.

osso_abook_contact_get_avatar_pixbuf ()

GdkPixbuf*          osso_abook_contact_get_avatar_pixbuf
                                                        (OssoABookContact *contact,
                                                         const char *username,
                                                         const char *vcard_field);

Gets the avatar image set for contact, using username and vcard_field to get the specific image for an account. If username and vcard_field are NULL, the returned image will be the first found. If you want to have notification for when the contact's avatar image changes you should use osso_abook_contact_get_avatar() to retrieve the OssoABookAvatar object and connect to the 'notify::avatar-image' signal of that object.

osso_abook_contact_get_name ()

const char*         osso_abook_contact_get_name         (OssoABookContact *contact);

Retrieves the text used to represent the name of contact internally. This string is formed according to the "/apps/osso-addressbook/name_order" preference. To keep it up to date, call this function again when the preference changes.

To display the name of a contact use osso_abook_contact_get_display_name().

osso_abook_contact_get_display_name ()

const char*         osso_abook_contact_get_display_name (OssoABookContact *contact);

Retrieves the text used to display the name of contact. This string is formed according to the "/apps/osso-addressbook/name_order" preference. To keep the display up to date, call this function again when the preference changes.

osso_abook_contact_get_name_components ()

void                osso_abook_contact_get_name_components
                                                        (EContact *contact,
                                                         OssoABookNameOrder order,
                                                         gboolean strict,
                                                         char **primary_out,
                                                         char **secondary_out);

Gets the primary and secondary name components for contact, according to specified order. If strict is FALSE and contact is missing a primary name component, this function will attempt to use a fallback primary name component.

The name components are returned in primary_out and secondary_out if those arguments are non-NULL. The returned strings are owned by the caller and must be freed with g_free().

osso_abook_contact_get_name_with_order ()

const char*         osso_abook_contact_get_name_with_order
                                                        (OssoABookContact *contact,
                                                         OssoABookNameOrder order);

Retrieves the text used to display the name of contact according to order.

osso_abook_contact_action_start ()

gboolean            osso_abook_contact_action_start     (OssoABookContactAction action,
                                                         OssoABookContact *contact,
                                                         EVCardAttribute *attribute,
                                                         McAccount *account,
                                                         GtkWindow *parent);

Simplified version of osso_abook_contact_action_start_with_callback() for actions that don't require a callback. See osso_abook_contact_action_start_with_callback() for more information.

osso_abook_contact_action_start_with_callback ()

gboolean            osso_abook_contact_action_start_with_callback
                                                        (OssoABookContactAction action,
                                                         OssoABookContact *contact,
                                                         EVCardAttribute *attribute,
                                                         McAccount *account,
                                                         GtkWindow *parent,
                                                         OssoABookContactActionStartCb callback,
                                                         gpointer callback_data);

Start an action for a contact. If the action is initiated successfully, both this function will return TRUE and the GError argument to callback will be NULL.

osso_abook_contact_to_string ()

char*               osso_abook_contact_to_string        (OssoABookContact *contact,
                                                         EVCardFormat format,
                                                         gboolean inline_avatar);

Creates a vCard string representation of the contact.

osso_abook_contact_get_basename ()

char*               osso_abook_contact_get_basename     (OssoABookContact *contact,
                                                         gboolean strict);

Creates the basename component that can be use for creating a filename for this contact (e.g. "basename.vcf" or "basename (n).vcf").

Return: A newly allocated string.

osso_abook_contact_write_to_file ()

void                osso_abook_contact_write_to_file    (OssoABookContact *contact,
                                                         EVCardFormat format,
                                                         gboolean inline_avatar,
                                                         gboolean strict_filename,
                                                         GFile *parent_file,
                                                         OssoABookContactWriteToFileCbcallback ,
                                                         gpointer user_data);

Writes contact out to a vCard file. The filename is automatically chosen from contact's name (see osso_abook_contact_get_basename() for more information). When the file has been written (or an error occurs), callback will be called to report the status of the operation.

osso_abook_contact_shortcut_exists ()

gboolean            osso_abook_contact_shortcut_exists  (OssoABookContact *contact,
                                                         GSList **ret_list);

Checks if contact currently has a home applet shortcut registered. If ret_list is non-NULL the list of all home applet shortcuts will be returned. The list and its contents are owned by the caller. Each element in the list is a string of the form OSSO_ABOOK_HOME_APPLET_PREFIX<UID>.

osso_abook_contact_shortcut_create ()

gboolean            osso_abook_contact_shortcut_create  (OssoABookContact *contact);

Creates a Home applet shortcut for contact. If contact already has a shortcut, a second shortcut will not be created.

osso_abook_contact_merge_roster_info ()

OssoABookContact*   osso_abook_contact_merge_roster_info
                                                        (OssoABookContact *contact);

This function retrieves all roster contacts of contact and merges the ContactInfo fields of these roster contacts with the fields of contact into a newly allocated OssoABookContact object. Duplicate fields are removed.

osso_abook_contact_fetch_roster_info ()

OssoABookContact*   osso_abook_contact_fetch_roster_info
                                                        (OssoABookContact *contact);

This function retrieves all roster contacts of contact, and adds ContactInfo fields of these roster contacts to a newly allocated OssoABookContact object. Duplicates fields are removed.

osso_abook_contact_get_collate_keys ()

const char**        osso_abook_contact_get_collate_keys (OssoABookContact *contact,
                                                         OssoABookNameOrder order);

Returns the locale specific sorting keys for contacts with respect to the preferred name order.

osso_abook_contact_collate ()

int                 osso_abook_contact_collate          (OssoABookContact *a,
                                                         OssoABookContact *b,
                                                         OssoABookNameOrder order);

Compares two contacts by name with respect to order and locale specific sorting rules.

osso_abook_contact_uid_compare ()

int                 osso_abook_contact_uid_compare      (OssoABookContact *a,
                                                         OssoABookContact *b);

Compares two contacts by their UID preserving those properties:

1. old contacts are listed before new contacts 2. file-backend contacts are listed before artificial contacts

osso_abook_contact_async_add ()

guint               osso_abook_contact_async_add        (OssoABookContact *contact,
                                                         EBook *book,
                                                         EBookIdCallback callback,
                                                         gpointer user_data);

Adds contact to book asynchronously. If book is NULL, contact will be added to the EBook associated with contact's roster (if any) or the system addressbook.

osso_abook_contact_async_commit ()

guint               osso_abook_contact_async_commit     (OssoABookContact *contact,
                                                         EBook *book,
                                                         EBookCallback callback,
                                                         gpointer user_data);

Applies the changes made to contact to the stored version in book without blocking. if async_commit virtual method is redefined the vcard could be saved on another place than the book. OssoABookSelfContact saves the vcard to a gconf key.

osso_abook_contact_commit ()

void                osso_abook_contact_commit           (OssoABookContact *contact,
                                                         gboolean create,
                                                         EBook *book,
                                                         GtkWindow *window);

Commits contact to book asynchronously. When book is NULL and contact is an OssoABookContact, then the contact's OssoABookRoster is queried to find the EBook this contact originates from.

osso_abook_contact_accept ()

void                osso_abook_contact_accept           (OssoABookContact *contact,
                                                         OssoABookContact *master,
                                                         GtkWindow *parent);

Adds contact to an IM account roster, authorizes contact to see our presence, and requests authorization from that contact to see their presence (if not already authorized). If master is specified, contact is attached to master. Any errors are handled internally and an error banner will be displayed.

osso_abook_contact_accept_for_uid ()

void                osso_abook_contact_accept_for_uid   (OssoABookContact *contact,
                                                         const char *master_uid,
                                                         GtkWindow *parent);

Adds contact to an IM account roster and optionally attaches contact to a master contact with uid equal to master_uid. This function is rarely useful; use osso_abook_contact_accept() instead.

osso_abook_contact_async_accept ()

void                osso_abook_contact_async_accept     (OssoABookContact *contact,
                                                         const char *master_uid,
                                                         EBookIdCallback callback,
                                                         gpointer user_data);

Adds contact to an IM account roster asynchronously and optionally attaches contact to a master contact with uid equal to master_uid. This function is rarely useful; use osso_abook_contact_accept() instead.

osso_abook_contact_reject ()

void                osso_abook_contact_reject           (OssoABookContact *contact,
                                                         GtkWindow *parent);

Remove contact and revoke authorization to see our presence.

osso_abook_contact_reject_for_uid ()

void                osso_abook_contact_reject_for_uid   (OssoABookContact *contact,
                                                         const char *master_uid,
                                                         GtkWindow *parent);

Detach contact from the master contact with UID equal to master_uid, and if contact is not attached to any other master contacts, it will removed and authorization revoked. This function is rarely useful; use osso_abook_contact_reject() instead.

osso_abook_contact_delete ()

gboolean            osso_abook_contact_delete           (OssoABookContact *contact,
                                                         EBook *book,
                                                         GtkWindow *window);

Deletes contact.

osso_abook_contact_delete_many ()

void                osso_abook_contact_delete_many      (GList *contacts,
                                                         EBook *book,
                                                         GtkWindow *window);

Deletes contacts.

osso_abook_contact_get_blocked ()

gboolean            osso_abook_contact_get_blocked      (OssoABookContact *contact);

Returns a boolean indicating whether contact is blocked or not.

osso_abook_contact_can_block ()

gboolean            osso_abook_contact_can_block        (OssoABookContact *contact,
                                                         const char **infoprint);

Checks if it is possible to block contact, and if not possible sets infoprint to point to a string explaining why not.

osso_abook_contact_can_request_auth ()

gboolean            osso_abook_contact_can_request_auth (OssoABookContact *contact,
                                                         const char **infoprint);

Checks if it is possible to request authorization for contact, and if not possible sets infoprint to point to a string explaining why not.

osso_abook_contact_vcard_clean ()

void                osso_abook_contact_vcard_clean      (EContact *contact);

Clean a contact, by removing all empty fields.

osso_abook_contact_has_valid_name ()

gboolean            osso_abook_contact_has_valid_name   (OssoABookContact *contact);

Checks if the contact contains an attribute that can be used as a display name.

osso_abook_contact_get_contact_photo ()

EContactPhoto*      osso_abook_contact_get_contact_photo
                                                        (EContact *contact);

Gets the value of contact's PHOTO field if usable, NULL otherwise. This is equivalent to calling e_contact_get for the E_CONTACT_PHOTO field, except that NULL is returned if the photo is not local (on a http server for instance) or it points to a non regular file.

If you just want a pixbuf use osso_abook_contact_get_photo().

The "display-name" property

  "display-name"             gchar*                : Read

The text used to display the name of the contact.

Default value: NULL

The "contact-attached" signal

void                user_function                      (OssoABookContact *master_contact,
                                                        OssoABookContact *roster_contact,
                                                        gpointer          user_data)           : Run First

This signal is emitted when a roster contact is associated with ("attached to") a master contact. At this point, master_contact's attributes may have changed, so any cached data should be re-loaded.

The "contact-detached" signal

void                user_function                      (OssoABookContact *master_contact,
                                                        OssoABookContact *roster_contact,
                                                        gpointer          user_data)           : Run First

This signal is emitted when a roster contact is no longer associated with ("detached from") a master contact. At this point, master_contact's attributes may have changed, so any cached data should be re-loaded.

The "reset" signal

void                user_function                      (OssoABookContact *master_contact,
                                                        gpointer          user_data)           : Run First

This signal is emitted when a contact's attributes are completely re-written. At this point, master_contact's attributes may have changed, so any cached data should be re-loaded.