Liblinphone 5.4.23
|
Create, manage and search contacts. More...
Typedefs | |
typedef struct _LinphoneMagicSearch | LinphoneMagicSearch |
A LinphoneMagicSearch is used to search for contacts from various sources: | |
typedef struct _LinphoneMagicSearchCbs | LinphoneMagicSearchCbs |
LinphoneMagicSearchCbs is an interface to be notified of results of contact searches initiated from the LinphoneMagicSearch. | |
typedef struct _LinphoneSearchResult | LinphoneSearchResult |
The LinphoneSearchResult object represents a result of a search initiated from a LinphoneMagicSearch. | |
typedef struct _LinphoneCardDavParams | LinphoneCardDavParams |
The LinphoneCardDavParams object represents a remote CardDAV server used by LinphoneMagicSearch as a plugin source. | |
typedef struct _LinphoneRemoteContactDirectory | LinphoneRemoteContactDirectory |
Object that represents a remote contact directory such as a LDAP or CardDAV server; used as a LinphoneMagicSearch source. | |
typedef struct _LinphoneFriendPhoneNumber | LinphoneFriendPhoneNumber |
Object that represents a LinphoneFriend's phone number. | |
typedef struct _LinphoneFriendDevice | LinphoneFriendDevice |
Object that represents a LinphoneFriend's device (name, trust level) for a given SIP address. |
Functions | |
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. | |
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. | |
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. | |
void | linphone_core_remove_remote_contact_directory (LinphoneCore *core, LinphoneRemoteContactDirectory *remoteContactDirectory) |
Removes a LinphoneRemoteContactDirectory object previously added to the Core. | |
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. | |
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. | |
LinphoneCardDavParams * | linphone_card_dav_params_clone (const LinphoneCardDavParams *params) |
Instantiates a new LinphoneCardDavParams with values from source. | |
LinphoneCardDavParams * | linphone_card_dav_params_ref (LinphoneCardDavParams *params) |
Takes a reference on a LinphoneCardDavParams. | |
void | linphone_card_dav_params_unref (LinphoneCardDavParams *params) |
Releases a LinphoneCardDavParams. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
LinphoneRemoteContactDirectory * | linphone_remote_contact_directory_ref (LinphoneRemoteContactDirectory *params) |
Takes a reference on a LinphoneRemoteContactDirectory. | |
void | linphone_remote_contact_directory_unref (LinphoneRemoteContactDirectory *params) |
Releases a LinphoneRemoteContactDirectory. | |
LinphoneRemoteContactDirectoryType | linphone_remote_contact_directory_get_type (const LinphoneRemoteContactDirectory *params) |
Gets the type of remote contact directory (LDAP, CardDAV). | |
LinphoneCardDavParams * | linphone_remote_contact_directory_get_card_dav_params (const LinphoneRemoteContactDirectory *params) |
Gets the CardDAV params if linphone_remote_contact_directory_get_type() returns CardDAV. | |
LinphoneLdapParams * | linphone_remote_contact_directory_get_ldap_params (const LinphoneRemoteContactDirectory *params) |
Gets the LDAP params if linphone_remote_contact_directory_get_type() returns LDAP. | |
const char * | linphone_remote_contact_directory_get_server_url (const LinphoneRemoteContactDirectory *params) |
Gets the configured remote contact directory server URL. | |
void | linphone_remote_contact_directory_set_server_url (LinphoneRemoteContactDirectory *params, const char *server_url) |
Sets the server URL to use to reach the remote contact directory server. | |
unsigned int | linphone_remote_contact_directory_get_limit (const LinphoneRemoteContactDirectory *params) |
Gets the maximum number of results to fetch, 0 means no limit. | |
void | linphone_remote_contact_directory_set_limit (LinphoneRemoteContactDirectory *params, unsigned int limit) |
Sets the maximum number of results to fetch, 0 means no limit. | |
unsigned int | linphone_remote_contact_directory_get_min_characters (const LinphoneRemoteContactDirectory *params) |
Gets the minimum number of characters to have before sending the query to the server. | |
void | linphone_remote_contact_directory_set_min_characters (LinphoneRemoteContactDirectory *params, unsigned int min) |
Sets the minimum number of characters to have before sending the query to the server. | |
unsigned int | linphone_remote_contact_directory_get_timeout (const LinphoneRemoteContactDirectory *params) |
Gets the timeout (in seconds) after which the query is abandonned. | |
void | linphone_remote_contact_directory_set_timeout (LinphoneRemoteContactDirectory *params, unsigned int seconds) |
Sets the timeout (in seconds) after which the query is abandonned. |
Create, manage and search contacts.
typedef struct _LinphoneMagicSearch LinphoneMagicSearch |
A LinphoneMagicSearch is used to search for contacts from various sources:
typedef struct _LinphoneMagicSearchCbs LinphoneMagicSearchCbs |
LinphoneMagicSearchCbs is an interface to be notified of results of contact searches initiated from the LinphoneMagicSearch.
LinphoneCardDavParams * linphone_card_dav_params_clone | ( | const LinphoneCardDavParams * | params | ) |
Instantiates a new LinphoneCardDavParams with values from source.
params | The LinphoneCardDavParams object to be cloned. |
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".
The | LinphoneCardDavParams object. |
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.
The | LinphoneCardDavParams object. |
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...
The | LinphoneCardDavParams object. |
LinphoneCardDavParams * linphone_card_dav_params_ref | ( | LinphoneCardDavParams * | params | ) |
Takes a reference on a LinphoneCardDavParams.
params | The 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".
The | LinphoneCardDavParams object. |
list | the list of vCard RFC fields to use to match the domain filter on. |
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.
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...
The | LinphoneCardDavParams object. |
list | the list of vCard RFC fields to use to match user input text on. |
void linphone_card_dav_params_unref | ( | LinphoneCardDavParams * | params | ) |
Releases a LinphoneCardDavParams.
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.
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.
core | LinphoneCore object. |
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.
core | LinphoneCore object. |
params | the LinphoneCardDavParams to configure this 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.
core | LinphoneCore object. |
params | the LinphoneLdapParams to configure this remote contact directory. |
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.
core | LinphoneCore object. |
void linphone_core_remove_remote_contact_directory | ( | LinphoneCore * | core, |
LinphoneRemoteContactDirectory * | remoteContactDirectory ) |
Removes a LinphoneRemoteContactDirectory object previously added to the Core.
core | LinphoneCore object. |
remoteContactDirectory | the LinphoneRemoteContactDirectory to remove. |
LinphoneCardDavParams * linphone_remote_contact_directory_get_card_dav_params | ( | const LinphoneRemoteContactDirectory * | params | ) |
Gets the CardDAV params if linphone_remote_contact_directory_get_type() returns CardDAV.
params | The LinphoneRemoteContactDirectory object. |
LinphoneLdapParams * linphone_remote_contact_directory_get_ldap_params | ( | const LinphoneRemoteContactDirectory * | params | ) |
Gets the LDAP params if linphone_remote_contact_directory_get_type() returns LDAP.
params | The LinphoneRemoteContactDirectory object. |
unsigned int linphone_remote_contact_directory_get_limit | ( | const LinphoneRemoteContactDirectory * | params | ) |
Gets the maximum number of results to fetch, 0 means no limit.
params | The LinphoneRemoteContactDirectory object. |
unsigned int linphone_remote_contact_directory_get_min_characters | ( | const LinphoneRemoteContactDirectory * | params | ) |
Gets the minimum number of characters to have before sending the query to the server.
params | The LinphoneRemoteContactDirectory object. |
const char * linphone_remote_contact_directory_get_server_url | ( | const LinphoneRemoteContactDirectory * | params | ) |
Gets the configured remote contact directory server URL.
params | The LinphoneRemoteContactDirectory object. |
unsigned int linphone_remote_contact_directory_get_timeout | ( | const LinphoneRemoteContactDirectory * | params | ) |
Gets the timeout (in seconds) after which the query is abandonned.
params | The LinphoneRemoteContactDirectory object. |
LinphoneRemoteContactDirectoryType linphone_remote_contact_directory_get_type | ( | const LinphoneRemoteContactDirectory * | params | ) |
Gets the type of remote contact directory (LDAP, CardDAV).
params | The LinphoneRemoteContactDirectory object. |
LinphoneRemoteContactDirectory * linphone_remote_contact_directory_ref | ( | LinphoneRemoteContactDirectory * | params | ) |
Takes a reference on a LinphoneRemoteContactDirectory.
params | The LinphoneRemoteContactDirectory object. |
void linphone_remote_contact_directory_set_limit | ( | LinphoneRemoteContactDirectory * | params, |
unsigned int | limit ) |
Sets the maximum number of results to fetch, 0 means no limit.
params | The LinphoneRemoteContactDirectory object. |
limit | the maximum number of results to return. |
void linphone_remote_contact_directory_set_min_characters | ( | LinphoneRemoteContactDirectory * | params, |
unsigned int | min ) |
Sets the minimum number of characters to have before sending the query to the server.
params | 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 * | params, |
const char * | server_url ) |
Sets the server URL to use to reach the remote contact directory server.
params | The LinphoneRemoteContactDirectory object. |
server_url | the remote contact directory server URL. |
void linphone_remote_contact_directory_set_timeout | ( | LinphoneRemoteContactDirectory * | params, |
unsigned int | seconds ) |
Sets the timeout (in seconds) after which the query is abandonned.
params | The LinphoneRemoteContactDirectory object. |
seconds | the number of seconds before considering the query as timed-out. |
void linphone_remote_contact_directory_unref | ( | LinphoneRemoteContactDirectory * | params | ) |
Releases a LinphoneRemoteContactDirectory.
params | The LinphoneRemoteContactDirectory object. |