Macros
#define	LINPHONE_VCARD BELLE_SIP_CAST(object, LinphoneVcard)

Typedefs
typedef struct _LinphoneVcard	LinphoneVcard

Functions
LINPHONE_DEPRECATED LinphoneVcard *	linphone_vcard_new (void)

LINPHONE_DEPRECATED void	linphone_vcard_free (LinphoneVcard *vCard)

LinphoneVcard *	linphone_vcard_ref (LinphoneVcard *vCard)

void	linphone_vcard_unref (LinphoneVcard *vCard)

const char *	linphone_vcard_as_vcard4_string (LinphoneVcard *vCard)

void	linphone_vcard_set_full_name (LinphoneVcard vCard, const char name)

const char *	linphone_vcard_get_full_name (const LinphoneVcard *vCard)

void	linphone_vcard_set_skip_validation (LinphoneVcard *vCard, bool_t skip)

bool_t	linphone_vcard_get_skip_validation (const LinphoneVcard *vCard)

void	linphone_vcard_set_family_name (LinphoneVcard vCard, const char name)

const char *	linphone_vcard_get_family_name (const LinphoneVcard *vCard)

void	linphone_vcard_set_given_name (LinphoneVcard vCard, const char name)

const char *	linphone_vcard_get_given_name (const LinphoneVcard *vCard)

void	linphone_vcard_add_sip_address (LinphoneVcard vCard, const char sip_address)

void	linphone_vcard_remove_sip_address (LinphoneVcard vCard, const char sip_address)

void	linphone_vcard_edit_main_sip_address (LinphoneVcard vCard, const char sip_address)

const bctbx_list_t *	linphone_vcard_get_sip_addresses (LinphoneVcard *vCard)

void	linphone_vcard_add_phone_number (LinphoneVcard vCard, const char phone)

void	linphone_vcard_remove_phone_number (LinphoneVcard vCard, const char phone)

bctbx_list_t *	linphone_vcard_get_phone_numbers (const LinphoneVcard *vCard)

void	linphone_vcard_set_organization (LinphoneVcard vCard, const char organization)

const char *	linphone_vcard_get_organization (const LinphoneVcard *vCard)

bool_t	linphone_vcard_generate_unique_id (LinphoneVcard *vCard)

void	linphone_vcard_set_uid (LinphoneVcard vCard, const char uid)

const char *	linphone_vcard_get_uid (const LinphoneVcard *vCard)

void	linphone_vcard_set_etag (LinphoneVcard vCard, const char etag)

const char *	linphone_vcard_get_etag (const LinphoneVcard *vCard)

void	linphone_vcard_set_url (LinphoneVcard vCard, const char url)

const char *	linphone_vcard_get_url (const LinphoneVcard *vCard)

Detailed Description

Macro Definition Documentation

§ LINPHONE_VCARD

#define LINPHONE_VCARD BELLE_SIP_CAST(object, LinphoneVcard)

Cast a belle_sip_object_t into LinphoneVcard.

Typedef Documentation

§ LinphoneVcard

typedef struct _LinphoneVcard LinphoneVcard

The LinphoneVcard object.

Function Documentation

§ linphone_vcard_add_phone_number()

void linphone_vcard_add_phone_number	(	LinphoneVcard *	vCard,
		const char *	phone
	)

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

Parameters

[in]	vCard	the LinphoneVcard
[in]	phone	the phone number to add

§ linphone_vcard_add_sip_address()

void linphone_vcard_add_sip_address	(	LinphoneVcard *	vCard,
		const char *	sip_address
	)

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

Parameters

[in]	vCard	the LinphoneVcard
[in]	sip_address	the SIP address to add

§ linphone_vcard_as_vcard4_string()

const char* linphone_vcard_as_vcard4_string ( LinphoneVcard * vCard )

Returns the vCard4 representation of the LinphoneVcard.

Parameters

[in] vCard the LinphoneVcard

Returns: a const char * that represents the vCard

§ linphone_vcard_edit_main_sip_address()

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

[in]	vCard	the LinphoneVcard
[in]	sip_address	the new SIP address

§ linphone_vcard_free()

LINPHONE_DEPRECATED void linphone_vcard_free ( LinphoneVcard * vCard )

Deletes a LinphoneVcard object properly

Parameters

[in] vCard the LinphoneVcard to destroy

Deprecated:: Use linphone_vcard_unref() or belle_sip_object_unref() instead.

§ linphone_vcard_generate_unique_id()

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

[in] vCard the LinphoneVcard

Returns: TRUE if operation is successful, otherwise FALSE (for example if it already has an unique ID)

§ linphone_vcard_get_etag()

const char* linphone_vcard_get_etag ( const LinphoneVcard * vCard )

Gets the eTag of the vCard

Parameters

[in] vCard the LinphoneVcard

Returns: the eTag of the vCard in the CardDAV server, otherwise NULL

§ linphone_vcard_get_family_name()

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

[in] vCard the LinphoneVcard

Returns: the family name of the vCard, or NULL

§ linphone_vcard_get_full_name()

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

[in] vCard the LinphoneVcard

Returns: the display name of the vCard, or NULL

§ linphone_vcard_get_given_name()

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

[in] vCard the LinphoneVcard

Returns: the given name of the vCard, or NULL

§ linphone_vcard_get_organization()

const char* linphone_vcard_get_organization ( const LinphoneVcard * vCard )

Gets the Organization of the vCard

Parameters

[in] vCard the LinphoneVcard

Returns: the Organization of the vCard or NULL

§ linphone_vcard_get_phone_numbers()

bctbx_list_t* linphone_vcard_get_phone_numbers ( const LinphoneVcard * vCard )

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

Parameters

[in] vCard the LinphoneVcard

Returns: A list of const char * objects.

§ linphone_vcard_get_sip_addresses()

const bctbx_list_t* linphone_vcard_get_sip_addresses ( LinphoneVcard * vCard )

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

Parameters

[in] vCard the LinphoneVcard

Returns: A list of LinphoneAddress objects.

§ linphone_vcard_get_skip_validation()

bool_t linphone_vcard_get_skip_validation ( const LinphoneVcard * vCard )

Returns the skipFieldValidation property of the vcard.

Parameters

[in] vCard the LinphoneVcard

Returns: the skipFieldValidation property of the vcard

§ linphone_vcard_get_uid()

const char* linphone_vcard_get_uid ( const LinphoneVcard * vCard )

Gets the UID of the vCard

Parameters

[in] vCard the LinphoneVcard

Returns: the UID of the vCard, otherwise NULL

§ linphone_vcard_get_url()

const char* linphone_vcard_get_url ( const LinphoneVcard * vCard )

Gets the URL of the vCard

Parameters

[in] vCard the LinphoneVcard

Returns: the URL of the vCard in the CardDAV server, otherwise NULL

§ linphone_vcard_new()

LINPHONE_DEPRECATED LinphoneVcard* linphone_vcard_new ( void )

Creates a LinphoneVcard object that has a pointer to an empty vCard

Returns: a new LinphoneVcard object

Deprecated:: Use linphone_factory_create_vcard() instead.

§ linphone_vcard_ref()

LinphoneVcard* linphone_vcard_ref ( LinphoneVcard * vCard )

Take a ref on a LinphoneVcard.

Parameters

[in] vCard LinphoneVcard object

§ linphone_vcard_remove_phone_number()

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

[in]	vCard	the LinphoneVcard
[in]	phone	the phone number to remove

§ linphone_vcard_remove_sip_address()

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

[in]	vCard	the LinphoneVcard
[in]	sip_address	the SIP address to remove

§ linphone_vcard_set_etag()

void linphone_vcard_set_etag	(	LinphoneVcard *	vCard,
		const char *	etag
	)

Sets the eTAG of the vCard

Parameters

[in]	vCard	the LinphoneVcard
[in]	etag	the eTAG

§ linphone_vcard_set_family_name()

void linphone_vcard_set_family_name	(	LinphoneVcard *	vCard,
		const char *	name
	)

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

Parameters

[in]	vCard	the LinphoneVcard
[in]	name	the family name to set for the vCard

§ linphone_vcard_set_full_name()

void linphone_vcard_set_full_name	(	LinphoneVcard *	vCard,
		const char *	name
	)

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

Parameters

[in]	vCard	the LinphoneVcard
[in]	name	the display name to set for the vCard

§ linphone_vcard_set_given_name()

void linphone_vcard_set_given_name	(	LinphoneVcard *	vCard,
		const char *	name
	)

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

Parameters

[in]	vCard	the LinphoneVcard
[in]	name	the given name to set for the vCard

§ linphone_vcard_set_organization()

void linphone_vcard_set_organization	(	LinphoneVcard *	vCard,
		const char *	organization
	)

Fills the Organization field of the vCard

Parameters

[in]	vCard	the LinphoneVcard
[in]	organization	the Organization

§ linphone_vcard_set_skip_validation()

void linphone_vcard_set_skip_validation	(	LinphoneVcard *	vCard,
		bool_t	skip
	)

Sets the skipFieldValidation property of the vcard

Parameters

[in]	vCard	the LinphoneVcard
[in]	skip	skipFieldValidation property of the vcard

§ linphone_vcard_set_uid()

void linphone_vcard_set_uid	(	LinphoneVcard *	vCard,
		const char *	uid
	)

Sets the unique ID of the vCard

Parameters

[in]	vCard	the LinphoneVcard
[in]	uid	the unique id

§ linphone_vcard_set_url()

void linphone_vcard_set_url	(	LinphoneVcard *	vCard,
		const char *	url
	)

Sets the URL of the vCard

Parameters

[in]	vCard	the LinphoneVcard
[in]	url	the URL

§ linphone_vcard_unref()

void linphone_vcard_unref ( LinphoneVcard * vCard )

Release a LinphoneVcard.

Parameters

[in] vCard LinphoneVcard object

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

§ LINPHONE_VCARD

Typedef Documentation

§ LinphoneVcard

Function Documentation

§ linphone_vcard_add_phone_number()

§ linphone_vcard_add_sip_address()

§ linphone_vcard_as_vcard4_string()

§ linphone_vcard_edit_main_sip_address()

§ linphone_vcard_free()

§ linphone_vcard_generate_unique_id()

§ linphone_vcard_get_etag()

§ linphone_vcard_get_family_name()

§ linphone_vcard_get_full_name()

§ linphone_vcard_get_given_name()

§ linphone_vcard_get_organization()

§ linphone_vcard_get_phone_numbers()

§ linphone_vcard_get_sip_addresses()

§ linphone_vcard_get_skip_validation()

§ linphone_vcard_get_uid()

§ linphone_vcard_get_url()

§ linphone_vcard_new()

§ linphone_vcard_ref()

§ linphone_vcard_remove_phone_number()

§ linphone_vcard_remove_sip_address()

§ linphone_vcard_set_etag()

§ linphone_vcard_set_family_name()

§ linphone_vcard_set_full_name()

§ linphone_vcard_set_given_name()

§ linphone_vcard_set_organization()

§ linphone_vcard_set_skip_validation()

§ linphone_vcard_set_uid()

§ linphone_vcard_set_url()

§ linphone_vcard_unref()