Liblinphone  5.3.0
Macros | Typedefs | Functions
Carddav_vcard

Macros

#define LINPHONE_VCARD   BELLE_SIP_CAST(object, LinphoneVcard)
 Cast a belle_sip_object_t into LinphoneVcard.
 

Typedefs

typedef struct _LinphoneVcard LinphoneVcard
 Object storing contact information using vCard 4.0 format.
 

Functions

LinphoneVcardlinphone_vcard_ref (LinphoneVcard *vCard)
 Take a ref on a LinphoneVcard. More...
 
void linphone_vcard_unref (LinphoneVcard *vCard)
 Release a LinphoneVcard. More...
 
LinphoneVcardlinphone_vcard_clone (const LinphoneVcard *vCard)
 Clone a LinphoneVcard. More...
 
const char * linphone_vcard_as_vcard4_string (LinphoneVcard *vCard)
 Returns the vCard4 representation of the LinphoneVcard. More...
 
void linphone_vcard_set_full_name (LinphoneVcard *vCard, const char *name)
 Sets the FN attribute of the vCard (which is mandatory). More...
 
const char * linphone_vcard_get_full_name (const LinphoneVcard *vCard)
 Returns the FN attribute of the vCard, or NULL if it isn't set yet. More...
 
void linphone_vcard_set_skip_validation (LinphoneVcard *vCard, bool_t skip)
 Sets the skipFieldValidation property of the vcard. More...
 
bool_t linphone_vcard_get_skip_validation (const LinphoneVcard *vCard)
 Returns the skipFieldValidation property of the vcard. More...
 
void linphone_vcard_set_family_name (LinphoneVcard *vCard, const char *name)
 Sets the family name in the N attribute of the vCard. More...
 
const char * linphone_vcard_get_family_name (const LinphoneVcard *vCard)
 Returns the family name in the N attribute of the vCard, or NULL if it isn't set yet. More...
 
void linphone_vcard_set_given_name (LinphoneVcard *vCard, const char *name)
 Sets the given name in the N attribute of the vCard. More...
 
const char * linphone_vcard_get_given_name (const LinphoneVcard *vCard)
 Returns the given name in the N attribute of the vCard, or NULL if it isn't set yet. More...
 
void linphone_vcard_add_sip_address (LinphoneVcard *vCard, const char *sip_address)
 Adds a SIP address in the vCard, using the IMPP property. More...
 
void linphone_vcard_remove_sip_address (LinphoneVcard *vCard, const char *sip_address)
 Removes a SIP address in the vCard (if it exists), using the IMPP property. More...
 
void linphone_vcard_edit_main_sip_address (LinphoneVcard *vCard, const char *sip_address)
 Edits the preferred SIP address in the vCard (or the first one), using the IMPP property. More...
 
const bctbx_list_t * linphone_vcard_get_sip_addresses (LinphoneVcard *vCard)
 Returns the list of SIP addresses in the vCard (all the IMPP attributes that has an URI value starting by "sip:") or NULL. More...
 
void linphone_vcard_add_phone_number (LinphoneVcard *vCard, const char *phone)
 Adds a phone number in the vCard, using the TEL property. More...
 
void linphone_vcard_remove_phone_number (LinphoneVcard *vCard, const char *phone)
 Removes a phone number in the vCard (if it exists), using the TEL property. More...
 
bctbx_list_t * linphone_vcard_get_phone_numbers (const LinphoneVcard *vCard)
 Returns the list of phone numbers in the vCard (all the TEL attributes) or NULL. More...
 
void linphone_vcard_add_phone_number_with_label (LinphoneVcard *vCard, LinphoneFriendPhoneNumber *phoneNumber)
 Adds a LinphoneFriendPhoneNumber in the vCard, using the TEL property. More...
 
void linphone_vcard_remove_phone_number_with_label (LinphoneVcard *vCard, const LinphoneFriendPhoneNumber *phoneNumber)
 Removes a LinphoneFriendPhoneNumber in the vCard (if it exists), using the TEL property. More...
 
bctbx_list_t * linphone_vcard_get_phone_numbers_with_label (const LinphoneVcard *vCard)
 Returns the list of phone numbers in the vCard (all the TEL attributes) or NULL. More...
 
void linphone_vcard_set_organization (LinphoneVcard *vCard, const char *organization)
 Fills the Organization field of the vCard. More...
 
const char * linphone_vcard_get_organization (const LinphoneVcard *vCard)
 Gets the Organization of the vCard. More...
 
void linphone_vcard_remove_organization (LinphoneVcard *vCard)
 Removes the Organization field of the vCard. More...
 
void linphone_vcard_set_job_title (LinphoneVcard *vCard, const char *job_title)
 Fills the Title field of the vCard. More...
 
const char * linphone_vcard_get_job_title (const LinphoneVcard *vCard)
 Gets the Title of the vCard. More...
 
void linphone_vcard_remove_job_title (LinphoneVcard *vCard)
 Removes the Title field of the vCard. More...
 
void linphone_vcard_set_photo (LinphoneVcard *vCard, const char *picture)
 Sets a picture URI in the vCard, using the PHOTO property. More...
 
void linphone_vcard_remove_photo (LinphoneVcard *vCard)
 Removes any existing PHOTO property. More...
 
const char * linphone_vcard_get_photo (const LinphoneVcard *vCard)
 Returns the first PHOTO property or NULL. More...
 
bool_t linphone_vcard_generate_unique_id (LinphoneVcard *vCard)
 Generates a random unique id for the vCard. More...
 
void linphone_vcard_set_uid (LinphoneVcard *vCard, const char *uid)
 Sets the unique ID of the vCard. More...
 
const char * linphone_vcard_get_uid (const LinphoneVcard *vCard)
 Gets the UID of the vCard. More...
 
void linphone_vcard_set_etag (LinphoneVcard *vCard, const char *etag)
 Sets the eTAG of the vCard. More...
 
const char * linphone_vcard_get_etag (const LinphoneVcard *vCard)
 Gets the eTag of the vCard. More...
 
void linphone_vcard_set_url (LinphoneVcard *vCard, const char *url)
 Sets the URL of the vCard. More...
 
const char * linphone_vcard_get_url (const LinphoneVcard *vCard)
 Gets the URL of the vCard. More...
 
bctbx_list_t * linphone_vcard_get_extended_properties_values_by_name (const LinphoneVcard *vCard, const char *name)
 Get the vCard extended properties values per property name. More...
 
void linphone_vcard_add_extended_property (LinphoneVcard *vCard, const char *name, const char *value)
 Adds an extended property to the vCard. More...
 
void linphone_vcard_remove_extented_properties_by_name (LinphoneVcard *vCard, const char *name)
 Remove all the extend properties per property name. More...
 

Detailed Description

Function Documentation

void linphone_vcard_add_extended_property ( LinphoneVcard vCard,
const char *  name,
const char *  value 
)

Adds an extended property to the vCard.

Parameters
vCardthe LinphoneVcard
namethe name of the extended property to add
valuethe value of the extended property to add
void linphone_vcard_add_phone_number ( LinphoneVcard vCard,
const char *  phone 
)

Adds a phone number in the vCard, using the TEL property.

Parameters
vCardthe LinphoneVcard
phonethe phone number to add
void linphone_vcard_add_phone_number_with_label ( LinphoneVcard vCard,
LinphoneFriendPhoneNumber phoneNumber 
)

Adds a LinphoneFriendPhoneNumber in the vCard, using the TEL property.

Parameters
vCardthe LinphoneVcard
phoneNumberthe LinphoneFriendPhoneNumber to add
void linphone_vcard_add_sip_address ( LinphoneVcard vCard,
const char *  sip_address 
)

Adds a SIP address in the vCard, using the IMPP property.

Parameters
vCardthe LinphoneVcard
sip_addressthe SIP address to add
const char* linphone_vcard_as_vcard4_string ( LinphoneVcard vCard)

Returns the vCard4 representation of the LinphoneVcard.

Parameters
vCardthe LinphoneVcard
Returns
a const char * that represents the vCard.
LinphoneVcard* linphone_vcard_clone ( const LinphoneVcard vCard)

Clone a LinphoneVcard.

Parameters
vCardLinphoneVcard object
Returns
a new LinphoneVcard object
void linphone_vcard_edit_main_sip_address ( LinphoneVcard vCard,
const char *  sip_address 
)

Edits the preferred SIP address in the vCard (or the first one), using the IMPP property.

Parameters
vCardthe LinphoneVcard
sip_addressthe new SIP address
bool_t linphone_vcard_generate_unique_id ( LinphoneVcard vCard)

Generates a random unique id for the vCard.

If is required to be able to synchronize the vCard with a CardDAV server

Parameters
vCardthe LinphoneVcard
Returns
TRUE if operation is successful, otherwise FALSE (for example if it already has an unique ID)
const char* linphone_vcard_get_etag ( const LinphoneVcard vCard)

Gets the eTag of the vCard.

Parameters
vCardthe LinphoneVcard
Returns
the eTag of the vCard in the CardDAV server, otherwise NULL.
bctbx_list_t* linphone_vcard_get_extended_properties_values_by_name ( const LinphoneVcard vCard,
const char *  name 
)

Get the vCard extended properties values per property name.

Parameters
vCardthe LinphoneVcard
namethe name to filter the extended properties on.
Returns
The extended properties values as string.
const char* linphone_vcard_get_family_name ( const LinphoneVcard vCard)

Returns the family name in the N attribute of the vCard, or NULL if it isn't set yet.

Parameters
vCardthe LinphoneVcard
Returns
the family name of the vCard, or NULL
const char* linphone_vcard_get_full_name ( const LinphoneVcard vCard)

Returns the FN attribute of the vCard, or NULL if it isn't set yet.

Parameters
vCardthe LinphoneVcard
Returns
the display name of the vCard, or NULL.
const char* linphone_vcard_get_given_name ( const LinphoneVcard vCard)

Returns the given name in the N attribute of the vCard, or NULL if it isn't set yet.

Parameters
vCardthe LinphoneVcard
Returns
the given name of the vCard, or NULL
const char* linphone_vcard_get_job_title ( const LinphoneVcard vCard)

Gets the Title of the vCard.

Parameters
vCardthe LinphoneVcard
Returns
the Title of the vCard or NULL.
const char* linphone_vcard_get_organization ( const LinphoneVcard vCard)

Gets the Organization of the vCard.

Parameters
vCardthe LinphoneVcard
Returns
the Organization of the vCard or NULL.
bctbx_list_t* linphone_vcard_get_phone_numbers ( const LinphoneVcard vCard)

Returns the list of phone numbers in the vCard (all the TEL attributes) or NULL.

Parameters
vCardthe LinphoneVcard
Returns
The phone numbers as string.
bctbx_list_t* linphone_vcard_get_phone_numbers_with_label ( const LinphoneVcard vCard)

Returns the list of phone numbers in the vCard (all the TEL attributes) or NULL.

Parameters
vCardthe LinphoneVcard
Returns
The phone numbers as LinphoneFriendPhoneNumber.
const char* linphone_vcard_get_photo ( const LinphoneVcard vCard)

Returns the first PHOTO property or NULL.

Parameters
vCardthe LinphoneVcard
Returns
The picture URI as string or NULL if none has been set.
const bctbx_list_t* linphone_vcard_get_sip_addresses ( LinphoneVcard vCard)

Returns the list of SIP addresses in the vCard (all the IMPP attributes that has an URI value starting by "sip:") or NULL.

Parameters
vCardthe LinphoneVcard
Returns
The SIP addresses.
bool_t linphone_vcard_get_skip_validation ( const LinphoneVcard vCard)

Returns the skipFieldValidation property of the vcard.

Parameters
vCardthe LinphoneVcard
Returns
the skipFieldValidation property of the vcard
const char* linphone_vcard_get_uid ( const LinphoneVcard vCard)

Gets the UID of the vCard.

Parameters
vCardthe LinphoneVcard
Returns
the UID of the vCard, otherwise NULL.
const char* linphone_vcard_get_url ( const LinphoneVcard vCard)

Gets the URL of the vCard.

Parameters
vCardthe LinphoneVcard
Returns
the URL of the vCard in the CardDAV server, otherwise NULL.
LinphoneVcard* linphone_vcard_ref ( LinphoneVcard vCard)

Take a ref on a LinphoneVcard.

Parameters
vCardLinphoneVcard object
Returns
the same LinphoneVcard object
void linphone_vcard_remove_extented_properties_by_name ( LinphoneVcard vCard,
const char *  name 
)

Remove all the extend properties per property name.

Parameters
vCardthe LinphoneVcard
namethe name to remove the extended properties on.
void linphone_vcard_remove_job_title ( LinphoneVcard vCard)

Removes the Title field of the vCard.

Parameters
vCardthe LinphoneVcard
void linphone_vcard_remove_organization ( LinphoneVcard vCard)

Removes the Organization field of the vCard.

Parameters
vCardthe LinphoneVcard
void linphone_vcard_remove_phone_number ( LinphoneVcard vCard,
const char *  phone 
)

Removes a phone number in the vCard (if it exists), using the TEL property.

Parameters
vCardthe LinphoneVcard
phonethe phone number to remove
void linphone_vcard_remove_phone_number_with_label ( LinphoneVcard vCard,
const LinphoneFriendPhoneNumber phoneNumber 
)

Removes a LinphoneFriendPhoneNumber in the vCard (if it exists), using the TEL property.

Parameters
vCardthe LinphoneVcard
phoneNumberthe LinphoneFriendPhoneNumber to remove
void linphone_vcard_remove_photo ( LinphoneVcard vCard)

Removes any existing PHOTO property.

Parameters
vCardthe LinphoneVcard
void linphone_vcard_remove_sip_address ( LinphoneVcard vCard,
const char *  sip_address 
)

Removes a SIP address in the vCard (if it exists), using the IMPP property.

Parameters
vCardthe LinphoneVcard
sip_addressthe SIP address to remove
void linphone_vcard_set_etag ( LinphoneVcard vCard,
const char *  etag 
)

Sets the eTAG of the vCard.

Parameters
vCardthe LinphoneVcard
etagthe eTAG.
void linphone_vcard_set_family_name ( LinphoneVcard vCard,
const char *  name 
)

Sets the family name in the N attribute of the vCard.

Parameters
vCardthe LinphoneVcard
namethe family name to set for the vCard
void linphone_vcard_set_full_name ( LinphoneVcard vCard,
const char *  name 
)

Sets the FN attribute of the vCard (which is mandatory).

Parameters
vCardthe LinphoneVcard
namethe display name to set for the vCard
void linphone_vcard_set_given_name ( LinphoneVcard vCard,
const char *  name 
)

Sets the given name in the N attribute of the vCard.

Parameters
vCardthe LinphoneVcard
namethe given name to set for the vCard
void linphone_vcard_set_job_title ( LinphoneVcard vCard,
const char *  job_title 
)

Fills the Title field of the vCard.

Parameters
vCardthe LinphoneVcard
job_titlethe job title.
void linphone_vcard_set_organization ( LinphoneVcard vCard,
const char *  organization 
)

Fills the Organization field of the vCard.

Parameters
vCardthe LinphoneVcard
organizationthe Organization.
void linphone_vcard_set_photo ( LinphoneVcard vCard,
const char *  picture 
)

Sets a picture URI in the vCard, using the PHOTO property.

Parameters
vCardthe LinphoneVcard
picturethe picture URI to add. If NULL it will have the same effet as linphone_vcard_remove_photo().
void linphone_vcard_set_skip_validation ( LinphoneVcard vCard,
bool_t  skip 
)

Sets the skipFieldValidation property of the vcard.

Parameters
vCardthe LinphoneVcard
skipskipFieldValidation property of the vcard
void linphone_vcard_set_uid ( LinphoneVcard vCard,
const char *  uid 
)

Sets the unique ID of the vCard.

Parameters
vCardthe LinphoneVcard
uidthe unique id
void linphone_vcard_set_url ( LinphoneVcard vCard,
const char *  url 
)

Sets the URL of the vCard.

Parameters
vCardthe LinphoneVcard
urlthe URL.
void linphone_vcard_unref ( LinphoneVcard vCard)

Release a LinphoneVcard.

Parameters
vCardLinphoneVcard object