Typedefs
typedef struct _LinphoneMagicSearch	LinphoneMagicSearch

typedef struct _LinphoneMagicSearchCbs	LinphoneMagicSearchCbs

typedef struct _LinphoneSearchResult	LinphoneSearchResult

typedef struct _LinphoneCardDavParams	LinphoneCardDavParams

typedef struct _LinphoneRemoteContactDirectory	LinphoneRemoteContactDirectory

typedef struct _LinphoneFriendPhoneNumber	LinphoneFriendPhoneNumber

typedef struct _LinphoneFriendDevice	LinphoneFriendDevice

Functions
LinphoneRemoteContactDirectory *	linphone_core_create_card_dav_remote_contact_directory (LinphoneCore core, LinphoneCardDavParams params)

LinphoneRemoteContactDirectory *	linphone_core_create_ldap_remote_contact_directory (LinphoneCore core, LinphoneLdapParams params)

void	linphone_core_add_remote_contact_directory (LinphoneCore core, LinphoneRemoteContactDirectory remoteContactDirectory)

void	linphone_core_remove_remote_contact_directory (LinphoneCore core, LinphoneRemoteContactDirectory remoteContactDirectory)

bctbx_list_t *	linphone_core_get_remote_contact_directories (LinphoneCore *core)

LinphoneCardDavParams *	linphone_core_create_card_dav_params (LinphoneCore *core)

LinphoneVcard *	linphone_core_create_vcard_from_text (const LinphoneCore core, const char input)

LinphoneCardDavParams *	linphone_card_dav_params_clone (const LinphoneCardDavParams *params)

LinphoneCardDavParams *	linphone_card_dav_params_ref (LinphoneCardDavParams *params)

void	linphone_card_dav_params_unref (LinphoneCardDavParams *params)

bctbx_list_t *	linphone_card_dav_params_get_user_input_fields (const LinphoneCardDavParams *params)

void	linphone_card_dav_params_set_user_input_fields (LinphoneCardDavParams params, bctbx_list_t list)

bctbx_list_t *	linphone_card_dav_params_get_domain_fields (const LinphoneCardDavParams *params)

void	linphone_card_dav_params_set_domain_fields (LinphoneCardDavParams params, const bctbx_list_t list)

bool_t	linphone_card_dav_params_get_use_exact_match_policy (const LinphoneCardDavParams *params)

void	linphone_card_dav_params_set_use_exact_match_policy (LinphoneCardDavParams *params, bool_t exact_match)

LinphoneRemoteContactDirectory *	linphone_remote_contact_directory_ref (LinphoneRemoteContactDirectory *remote_contact_directory)

void	linphone_remote_contact_directory_unref (LinphoneRemoteContactDirectory *remote_contact_directory)

void	linphone_remote_contact_directory_enable (LinphoneRemoteContactDirectory *remote_contact_directory, bool_t value)

bool_t	linphone_remote_contact_directory_enabled (const LinphoneRemoteContactDirectory *remote_contact_directory)

LinphoneRemoteContactDirectoryType	linphone_remote_contact_directory_get_type (const LinphoneRemoteContactDirectory *remote_contact_directory)

LinphoneCardDavParams *	linphone_remote_contact_directory_get_card_dav_remote_contact_directory (const LinphoneRemoteContactDirectory *remote_contact_directory)

LinphoneLdapParams *	linphone_remote_contact_directory_get_ldap_remote_contact_directory (const LinphoneRemoteContactDirectory *remote_contact_directory)

const char *	linphone_remote_contact_directory_get_server_url (const LinphoneRemoteContactDirectory *remote_contact_directory)

void	linphone_remote_contact_directory_set_server_url (LinphoneRemoteContactDirectory remote_contact_directory, const char server_url)

unsigned int	linphone_remote_contact_directory_get_limit (const LinphoneRemoteContactDirectory *remote_contact_directory)

void	linphone_remote_contact_directory_set_limit (LinphoneRemoteContactDirectory *remote_contact_directory, unsigned int limit)

unsigned int	linphone_remote_contact_directory_get_min_characters (const LinphoneRemoteContactDirectory *remote_contact_directory)

void	linphone_remote_contact_directory_set_min_characters (LinphoneRemoteContactDirectory *remote_contact_directory, unsigned int min)

unsigned int	linphone_remote_contact_directory_get_timeout (const LinphoneRemoteContactDirectory *remote_contact_directory)

void	linphone_remote_contact_directory_set_timeout (LinphoneRemoteContactDirectory *remote_contact_directory, unsigned int seconds)

void	linphone_remote_contact_directory_set_delay (LinphoneRemoteContactDirectory *remote_contact_directory, int milliseconds)

int	linphone_remote_contact_directory_get_delay (const LinphoneRemoteContactDirectory *remote_contact_directory)

Detailed Description

Create, manage and search contacts.

Typedef Documentation

typedef struct _LinphoneMagicSearch LinphoneMagicSearch

A LinphoneMagicSearch is used to search for contacts from various sources:

LinphoneFriendList
Ldap connection (see LinphoneLdap)
Remote CardDAV server (see LinphoneCardDavParams)
Call logs, conferences and existing chat rooms.
See also
linphone_magic_search_get_contacts_list_async()

typedef struct _LinphoneMagicSearchCbs LinphoneMagicSearchCbs

LinphoneMagicSearchCbs is an interface to be notified of results of contact searches initiated from the LinphoneMagicSearch.

See also: linphone_magic_search_add_callbacks()

Function Documentation

LinphoneCardDavParams* linphone_card_dav_params_clone ( const LinphoneCardDavParams * params )

Instantiates a new LinphoneCardDavParams with values from source.

Parameters

params The LinphoneCardDavParams object to be cloned.

Returns: The newly created LinphoneCardDavParams object.

bctbx_list_t* linphone_card_dav_params_get_domain_fields ( const LinphoneCardDavParams * params )

Gets the list of vCard RFC fields to use to match the domain filter on.

For example, you can use "IMPP".

Parameters

params The LinphoneCardDavParams object.

Returns: The list of vCard fields to make the query on using domain filter. A list of char * objects.

Warning: DO NOT USE ANYMORE, it won't have any effect.

Deprecated:: 06/10/2025 domain filter will be applied locally instead of using a CardDAV prop filter XML tag.

bool_t linphone_card_dav_params_get_use_exact_match_policy ( const LinphoneCardDavParams * params )

Gets the matching policy: TRUE if the remote vCard value must match the filter exactly, FALSE if it only needs to contain the filter.

Parameters

params The LinphoneCardDavParams object.

Returns: The matching policy: TRUE if the remote vCard value must match the filter exactly, FALSE if it only needs to contain the filter.

bctbx_list_t* linphone_card_dav_params_get_user_input_fields ( const LinphoneCardDavParams * params )

Gets the list of vCard RFC fields to use to match user input text on.

For example, you can use "FN", "N", "IMPP", "ORG", etc...

Parameters

params The LinphoneCardDavParams object.

Returns: The list of vCard fields to make the query on using user input. A list of char * objects.

LinphoneCardDavParams* linphone_card_dav_params_ref ( LinphoneCardDavParams * params )

Takes a reference on a LinphoneCardDavParams.

Parameters

params The LinphoneCardDavParams object.

Returns: the same LinphoneCardDavParams object.

void linphone_card_dav_params_set_domain_fields	(	LinphoneCardDavParams *	params,
		const bctbx_list_t *	list
	)

Sets the list of vCard RFC fields to use to match the domain filter on.

For example, you can use "IMPP".

Parameters

params	The LinphoneCardDavParams object.
list	the list of vCard RFC fields to use to match the domain filter on. A list of const char * objects.

Warning: DO NOT USE ANYMORE, it won't have any effect.

Deprecated:: 06/10/2025 domain filter will be applied locally instead of using a CardDAV prop filter XML tag.

void linphone_card_dav_params_set_use_exact_match_policy	(	LinphoneCardDavParams *	params,
		bool_t	exact_match
	)

Sets the matching policy: TRUE if the remote vCard value must match the filter exactly, FALSE if it only needs to contain the filter.

Parameters

params	The LinphoneCardDavParams object.
exact_match	the policy to use: TRUE if the remote vCard value must match the filter exactly, FALSE if it only needs to contain the filter.

void linphone_card_dav_params_set_user_input_fields	(	LinphoneCardDavParams *	params,
		bctbx_list_t *	list
	)

Sets the list of vCard RFC fields to use to match user input text on.

For example, you can use "FN", "N", "IMPP", "ORG", etc...

Parameters

params	The LinphoneCardDavParams object.
list	the list of vCard RFC fields to use to match user input text on. A list of char * objects.

void linphone_card_dav_params_unref ( LinphoneCardDavParams * params )

Releases a LinphoneCardDavParams.

Parameters

params The LinphoneCardDavParams object.

void linphone_core_add_remote_contact_directory	(	LinphoneCore *	core,
		LinphoneRemoteContactDirectory *	remoteContactDirectory
	)

Adds a LinphoneRemoteContactDirectory object previously created to the Core, to be used later by LinphoneMagicSearch to query contacts using either LDAP or CardDAV.

Parameters

core	LinphoneCore object.
remoteContactDirectory	the newly created LinphoneRemoteContactDirectory to add.

LinphoneCardDavParams* linphone_core_create_card_dav_params ( LinphoneCore * core )

Creates a new CardDAV server params object that may be used later by LinphoneMagicSearch to query contacts.

Parameters

core	LinphoneCore object.

Returns: a new LinphoneCardDavParams object to configure, and then use it to create a LinphoneRemoteContactDirectory using linphone_core_create_card_dav_remote_contact_directory().

LinphoneRemoteContactDirectory* linphone_core_create_card_dav_remote_contact_directory	(	LinphoneCore *	core,
		LinphoneCardDavParams *	params
	)

Creates a new CardDAV server params object that may be used later by LinphoneMagicSearch to query contacts.

Parameters

core	LinphoneCore object.
params	the LinphoneCardDavParams to configure this remote contact directory.

Returns: a new LinphoneRemoteContactDirectory object to configure, and then add using linphone_core_add_remote_contact_directory().

LinphoneRemoteContactDirectory* linphone_core_create_ldap_remote_contact_directory	(	LinphoneCore *	core,
		LinphoneLdapParams *	params
	)

Creates a new CardDAV server params object that may be used later by LinphoneMagicSearch to query contacts.

Parameters

core	LinphoneCore object.
params	the LinphoneLdapParams to configure this remote contact directory.

Returns: a new LinphoneRemoteContactDirectory object to configure, and then add using linphone_core_add_remote_contact_directory().

LinphoneVcard* linphone_core_create_vcard_from_text	(	const LinphoneCore *	core,
		const char *	input
	)

Creates a vCard from a text, if possible.

Parameters

core	LinphoneCore object.
input	the vCard raw text to parse.

Returns: a new LinphoneVcard object if the parsing of the input succeeded, NULL otherwise.

bctbx_list_t* linphone_core_get_remote_contact_directories ( LinphoneCore * core )

Gets the list of currently configured LDAP or CardDAV remote servers used by LinphoneMagicSearch.

Parameters

core	LinphoneCore object.

Returns: the list of LinphoneRemoteContactDirectory currently configured, if any. A list of LinphoneRemoteContactDirectory objects.

void linphone_core_remove_remote_contact_directory	(	LinphoneCore *	core,
		LinphoneRemoteContactDirectory *	remoteContactDirectory
	)

Removes a LinphoneRemoteContactDirectory object previously added to the Core.

Parameters

core	LinphoneCore object.
remoteContactDirectory	the LinphoneRemoteContactDirectory to remove.

void linphone_remote_contact_directory_enable	(	LinphoneRemoteContactDirectory *	remote_contact_directory,
		bool_t	value
	)

Enable this remote contact directory, ie make it usable for searches with the LinphoneMagicSearch object.

Parameters

remote_contact_directory	The LinphoneRemoteContactDirectory object.
value	A boolean.

bool_t linphone_remote_contact_directory_enabled ( const LinphoneRemoteContactDirectory * remote_contact_directory )

Returns whether this remote contact directory is enabled, i.e.

usable for searches with the LinphoneMagicSearch .

Parameters

remote_contact_directory The LinphoneRemoteContactDirectory object.

Returns: a boolean.

LinphoneCardDavParams* linphone_remote_contact_directory_get_card_dav_remote_contact_directory ( const LinphoneRemoteContactDirectory * remote_contact_directory )

Gets the CardDAV remote contact directory if linphone_remote_contact_directory_get_type() returns CardDAV.

Parameters

remote_contact_directory The LinphoneRemoteContactDirectory object.

Returns: the LinphoneCardDavParams or NULL if not of CardDAV type.

int linphone_remote_contact_directory_get_delay ( const LinphoneRemoteContactDirectory * remote_contact_directory )

Get the delay between each search in milliseconds.

Only available for LinphoneRemoteContactDirectoryTypeLdap

Parameters

remote_contact_directory The LinphoneRemoteContactDirectory object.

Returns: The delay in milliseconds.

LinphoneLdapParams* linphone_remote_contact_directory_get_ldap_remote_contact_directory ( const LinphoneRemoteContactDirectory * remote_contact_directory )

Gets the LDAP remote contact directory if linphone_remote_contact_directory_get_type() returns LDAP.

Parameters

remote_contact_directory The LinphoneRemoteContactDirectory object.

Returns: the LinphoneLdapParams or NULL if not of LDAP type.

unsigned int linphone_remote_contact_directory_get_limit ( const LinphoneRemoteContactDirectory * remote_contact_directory )

Gets the maximum number of results to fetch, 0 means no limit.

Parameters

remote_contact_directory The LinphoneRemoteContactDirectory object.

Returns: the maximum number of results, 0 means no limit.

unsigned int linphone_remote_contact_directory_get_min_characters ( const LinphoneRemoteContactDirectory * remote_contact_directory )

Gets the minimum number of characters to have before sending the query to the server.

Parameters

remote_contact_directory The LinphoneRemoteContactDirectory object.

Returns: The mininum number of characters to have before sending the query.

const char* linphone_remote_contact_directory_get_server_url ( const LinphoneRemoteContactDirectory * remote_contact_directory )

Gets the configured remote contact directory server URL.

Parameters

remote_contact_directory The LinphoneRemoteContactDirectory object.

Returns: the remote contact directory server URL.

unsigned int linphone_remote_contact_directory_get_timeout ( const LinphoneRemoteContactDirectory * remote_contact_directory )

Gets the timeout (in seconds) after which the query is abandonned.

Parameters

remote_contact_directory The LinphoneRemoteContactDirectory object.

Returns: The timeout (in seconds) after which the query is considered to be timed-out.

LinphoneRemoteContactDirectoryType linphone_remote_contact_directory_get_type ( const LinphoneRemoteContactDirectory * remote_contact_directory )

Gets the type of remote contact directory (LDAP, CardDAV).

Parameters

remote_contact_directory The LinphoneRemoteContactDirectory object.

Returns: the LinphoneRemoteContactDirectoryType of this remote contact directory.

LinphoneRemoteContactDirectory* linphone_remote_contact_directory_ref ( LinphoneRemoteContactDirectory * remote_contact_directory )

Takes a reference on a LinphoneRemoteContactDirectory.

Parameters

remote_contact_directory The LinphoneRemoteContactDirectory object.

Returns: the same LinphoneRemoteContactDirectory object.

void linphone_remote_contact_directory_set_delay	(	LinphoneRemoteContactDirectory *	remote_contact_directory,
		int	milliseconds
	)

Set the delay between each search in milliseconds.

Only available for LinphoneRemoteContactDirectoryTypeLdap Default value : 500.

Parameters

remote_contact_directory	The LinphoneRemoteContactDirectory object.
milliseconds	The timeout in milliseconds.

void linphone_remote_contact_directory_set_limit	(	LinphoneRemoteContactDirectory *	remote_contact_directory,
		unsigned int	limit
	)

Sets the maximum number of results to fetch, 0 means no limit.

Parameters

remote_contact_directory	The LinphoneRemoteContactDirectory object.
limit	the maximum number of results to return.

void linphone_remote_contact_directory_set_min_characters	(	LinphoneRemoteContactDirectory *	remote_contact_directory,
		unsigned int	min
	)

Sets the minimum number of characters to have before sending the query to the server.

Parameters

remote_contact_directory	The LinphoneRemoteContactDirectory object.
min	the minimum characters to have in user input filter before sending the query.

void linphone_remote_contact_directory_set_server_url	(	LinphoneRemoteContactDirectory *	remote_contact_directory,
		const char *	server_url
	)

Sets the server URL to use to reach the remote contact directory server.

Parameters

remote_contact_directory	The LinphoneRemoteContactDirectory object.
server_url	the remote contact directory server URL.

void linphone_remote_contact_directory_set_timeout	(	LinphoneRemoteContactDirectory *	remote_contact_directory,
		unsigned int	seconds
	)

Sets the timeout (in seconds) after which the query is abandonned.

Parameters

remote_contact_directory	The LinphoneRemoteContactDirectory object.
seconds	the number of seconds before considering the query as timed-out.

void linphone_remote_contact_directory_unref ( LinphoneRemoteContactDirectory * remote_contact_directory )

Releases a LinphoneRemoteContactDirectory.

Parameters

remote_contact_directory The LinphoneRemoteContactDirectory object.

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation