|
Liblinphone 5.5.0
|
Typedefs | |
| typedef enum _LinphoneRemoteContactDirectoryType | LinphoneRemoteContactDirectoryType |
| typedef struct _LinphoneLdap | LinphoneLdap |
| typedef struct _LinphoneLdapParams | LinphoneLdapParams |
| typedef enum _LinphoneLdapDebugLevel | LinphoneLdapDebugLevel |
| typedef enum _LinphoneLdapAuthMethod | LinphoneLdapAuthMethod |
| typedef enum _LinphoneLdapCertVerificationMode | LinphoneLdapCertVerificationMode |
| typedef enum _LinphoneLdapCheck | LinphoneLdapCheck |
Enumerations | |
| enum | _LinphoneRemoteContactDirectoryType { LinphoneRemoteContactDirectoryTypeCardDav = 0 , LinphoneRemoteContactDirectoryTypeLdap = 1 } |
| enum | _LinphoneLdapDebugLevel { LinphoneLdapDebugLevelOff = 0 , LinphoneLdapDebugLevelVerbose = 1 } |
| enum | _LinphoneLdapAuthMethod { LinphoneLdapAuthMethodAnonymous = 0 , LinphoneLdapAuthMethodSimple = 1 } |
| enum | _LinphoneLdapCertVerificationMode { LinphoneLdapCertVerificationDefault = -1 , LinphoneLdapCertVerificationDisabled = 0 , LinphoneLdapCertVerificationEnabled = 1 } |
| enum | _LinphoneLdapCheck { LinphoneLdapCheckOk = 0 , LinphoneLdapCheckServerEmpty = 1 , LinphoneLdapCheckServerNotUrl = 2 , LinphoneLdapCheckServerNoScheme = 4 , LinphoneLdapCheckServerNotLdap = 8 , LinphoneLdapCheckServerLdaps , LinphoneLdapCheckBaseObjectEmpty = 32 , LinphoneLdapCheckMissingFields = 64 } |
Using LDAP or CardDav remote contact directories to lookup contacts.
| typedef struct _LinphoneLdap LinphoneLdap |
Object that represents a LDAP connection.
Use a LinphoneLdapParams object to configure it.
| enum _LinphoneLdapCheck |
Enum describing errors in LDAP parameters.
Enum describing the type of LinphoneRemoteContactDirectory (currently CardDAV or LDAP).
| Enumerator | |
|---|---|
| LinphoneRemoteContactDirectoryTypeCardDav | Remote contact directory will use LinphoneCardDavParams. |
| LinphoneRemoteContactDirectoryTypeLdap | Remote contact directory will use LinphoneLdapParams. |
| 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. |
| LinphoneLdapParams * linphone_core_create_ldap_params | ( | LinphoneCore * | core | ) |
Create a LDAP params using default values from Linphone core.
Check LinphoneLdapParams to update values. In order to add a new LDAP configuration to LinphoneMagicSearch, these parameters must be passed to linphone_core_create_ldap_remote_contact_directory().
| core | LinphoneCore object |
| 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. |
| LinphoneVcard * linphone_core_create_vcard_from_text | ( | const LinphoneCore * | core, |
| const char * | input | ||
| ) |
Creates a vCard from a text, if possible.
| core | LinphoneCore object. |
| input | the vCard raw text to parse. |
| 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. |
| bool_t linphone_core_ldap_available | ( | LinphoneCore * | core | ) |
End of group contacts.
Tells if LDAP is available
| 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. |
| int linphone_ldap_params_check | ( | const LinphoneLdapParams * | params | ) |
Check parameters and return what are wrong.
| params | The LinphoneLdapParams object. |
| LinphoneLdapParams * linphone_ldap_params_clone | ( | const LinphoneLdapParams * | params | ) |
Instantiate a new LinphoneLdapParams with values from source.
| params | The LinphoneLdapParams object to be cloned. |
| void linphone_ldap_params_enable_sal | ( | LinphoneLdapParams * | params, |
| bool_t | enable | ||
| ) |
Handle the DNS resolution using liblinphone's own resolver, which allows to use DNS SRV records.
Default value : TRUE.
| params | The LinphoneLdapParams object. |
| enable | Enable or not the use of own DNS resolver. |
| void linphone_ldap_params_enable_tls | ( | LinphoneLdapParams * | params, |
| bool_t | enable | ||
| ) |
Encrypt transactions by LDAP over TLS(StartTLS).
You must use 'ldap' scheme. 'ldaps' for LDAP over SSL is non-standardized and deprecated. StartTLS in an extension to the LDAP protocol which uses the TLS protocol to encrypt communication. It works by establishing a normal - i.e. unsecured - connection with the LDAP server before a handshake negotiation between the server and the web services is carried out. Here, the server sends its certificate to prove its identity before the secure connection is established. Default value : TRUE.
| params | The LinphoneLdapParams object. |
| enable | Enable or not the use of TLS. |
| LinphoneLdapAuthMethod linphone_ldap_params_get_auth_method | ( | const LinphoneLdapParams * | params | ) |
Gets the authentification method.
Check LinphoneLdapAuthMethod for authentification values.
| params | The LinphoneLdapParams object. |
| const char * linphone_ldap_params_get_base_object | ( | const LinphoneLdapParams * | params | ) |
Gets the BaseObject.
It is a specification for LDAP Search Scopes that specifies that the Search Request should only be performed against the entry specified as the search base DN. No entries above it will be considered. This field is required.
| params | The LinphoneLdapParams object. |
| const char * linphone_ldap_params_get_bind_dn | ( | const LinphoneLdapParams * | params | ) |
Gets the Bind DN to use for bindings.
The bindDN DN is the credential that is used to authenticate against an LDAP. If empty, the connection will be Anonymous. eg: cn=ausername,ou=people,dc=bc,dc=com
| params | The LinphoneLdapParams object. |
| const char * linphone_ldap_params_get_custom_value | ( | const LinphoneLdapParams * | params, |
| const char * | key | ||
| ) |
Gets the value from field.
| params | The LinphoneLdapParams object. |
| key | The key string. |
| LinphoneLdapDebugLevel linphone_ldap_params_get_debug_level | ( | const LinphoneLdapParams * | params | ) |
Return the debug verbosity level.
| params | The LinphoneLdapParams object. |
| int linphone_ldap_params_get_delay | ( | const LinphoneLdapParams * | params | ) |
Gets the delay between each search in milliseconds.
| params | The LinphoneLdapParams object. |
| bool_t linphone_ldap_params_get_enabled | ( | const LinphoneLdapParams * | params | ) |
Return if the configuration is enabled.
| params | The LinphoneLdapParams object. |
| const char * linphone_ldap_params_get_filter | ( | const LinphoneLdapParams * | params | ) |
Gets the search is based on this filter to search contacts.
| params | The LinphoneLdapParams object. |
| int linphone_ldap_params_get_max_results | ( | const LinphoneLdapParams * | params | ) |
Gets the max results when requesting searches.
0 means the results aren't limited (but magic search limitation may apply).
| params | The LinphoneLdapParams object. |
| int linphone_ldap_params_get_min_chars | ( | const LinphoneLdapParams * | params | ) |
Gets the minimum characters needed for doing a search on LDAP servers.
| params | The LinphoneLdapParams object. |
| const char * linphone_ldap_params_get_name_attribute | ( | const LinphoneLdapParams * | params | ) |
Gets the list of LDAP attributes to check for the contact name, separated by a comma and the first being the highest priority.
| params | The LinphoneLdapParams object. |
| const char * linphone_ldap_params_get_password | ( | const LinphoneLdapParams * | params | ) |
Gets the password to pass to server when binding.
| params | The LinphoneLdapParams object. |
| const char * linphone_ldap_params_get_server | ( | const LinphoneLdapParams * | params | ) |
Gets the LDAP Server.
| params | The LinphoneLdapParams object. |
| LinphoneLdapCertVerificationMode linphone_ldap_params_get_server_certificates_verification_mode | ( | const LinphoneLdapParams * | params | ) |
Return whether the tls server certificate must be verified when connecting to a LDAP server.
| params | The LinphoneLdapParams object. |
| const char * linphone_ldap_params_get_sip_attribute | ( | const LinphoneLdapParams * | params | ) |
Gets the attributes to build the SIP username in address of Friend.
Attributes are separated by a comma.
| params | The LinphoneLdapParams object. |
| const char * linphone_ldap_params_get_sip_domain | ( | const LinphoneLdapParams * | params | ) |
Gets the domain to the sip address(sip:username@domain).
| params | The LinphoneLdapParams object. |
| int linphone_ldap_params_get_timeout | ( | const LinphoneLdapParams * | params | ) |
Gets the timeout for requests in seconds.
| params | The LinphoneLdapParams object. |
| int linphone_ldap_params_get_timeout_tls_ms | ( | const LinphoneLdapParams * | params | ) |
Gets the timeout for TLS connection in milliseconds.
| params | The LinphoneLdapParams object. |
| LinphoneLdapParams * linphone_ldap_params_ref | ( | LinphoneLdapParams * | params | ) |
Take a reference on a LinphoneLdapParams.
| params | The LinphoneLdapParams object. |
| bool_t linphone_ldap_params_sal_enabled | ( | const LinphoneLdapParams * | params | ) |
Handle the DNS resolution using liblinphone's own resolver, which allows to use DNS SRV records.
| params | The LinphoneLdapParams object. |
| void linphone_ldap_params_set_auth_method | ( | LinphoneLdapParams * | params, |
| LinphoneLdapAuthMethod | auth_method | ||
| ) |
Authentification method.
Check LinphoneLdapAuthMethod for authentification values. Default value : LinphoneLdapAuthMethodSimple
| params | The LinphoneLdapParams object. |
| auth_method | The LinphoneLdapAuthMethod. |
| void linphone_ldap_params_set_base_object | ( | LinphoneLdapParams * | params, |
| const char * | base_object | ||
| ) |
BaseObject is a specification for LDAP Search Scopes that specifies that the Search Request should only be performed against the entry specified as the search base DN.
No entries above it will be considered. This field is required. Default value : "dc=example,dc=com"
| params | The LinphoneLdapParams object. |
| base_object | The specification. |
| void linphone_ldap_params_set_bind_dn | ( | LinphoneLdapParams * | params, |
| const char * | bind_dn | ||
| ) |
Bind DN to use for bindings.
The bindDN DN is the credential that is used to authenticate against an LDAP. If empty, the connection will be Anonymous. eg: cn=ausername,ou=people,dc=bc,dc=com Default value : "".
| params | The LinphoneLdapParams object. |
| bind_dn | The Bind DN to use for bindings. |
| void linphone_ldap_params_set_custom_value | ( | LinphoneLdapParams * | params, |
| const char * | key, | ||
| const char * | value | ||
| ) |
Set custom field.
| params | The LinphoneLdapParams object. |
| key | The key string. |
| value | The value string. |
| void linphone_ldap_params_set_debug_level | ( | LinphoneLdapParams * | params, |
| LinphoneLdapDebugLevel | level | ||
| ) |
The debug verbosity level from internal LDAP API.
Values are LinphoneLdapDebugLevel Default value: LinphoneLdapDebugLevelOff
| params | The LinphoneLdapParams object. |
| level | The LinphoneLdapDebugLevel debug level. |
| void linphone_ldap_params_set_delay | ( | LinphoneLdapParams * | params, |
| int | delay | ||
| ) |
Delay between each search in milliseconds Default value : 500.
| params | The LinphoneLdapParams object. |
| delay | The timeout in milliseconds. |
| void linphone_ldap_params_set_enabled | ( | LinphoneLdapParams * | params, |
| bool_t | enable | ||
| ) |
If this config is enabled.
Default value : FALSE.
| params | The LinphoneLdapParams object. |
| enable | Enable or not the LDAP configuration. |
| void linphone_ldap_params_set_filter | ( | LinphoneLdapParams * | params, |
| const char * | filter | ||
| ) |
The search is based on this filter to search contacts.
Default value : "(sn=*%s*)".
| params | The LinphoneLdapParams object. |
| filter | The filter to use. |
| void linphone_ldap_params_set_max_results | ( | LinphoneLdapParams * | params, |
| int | max_results | ||
| ) |
The max results when requesting searches.
Default value : 5. This value fit for standard cases where only first results are needed. Also, it avoids latency on each searchs. Set this value to 0 to have an unlimited search (but magic search limitation may apply).
| params | The LinphoneLdapParams object. |
| max_results | The max results when requesting searches. |
| void linphone_ldap_params_set_min_chars | ( | LinphoneLdapParams * | params, |
| int | min_chars | ||
| ) |
The minimum characters needed for doing a search on LDAP servers.
Default value : 0.
| params | The LinphoneLdapParams object. |
| min_chars | The minimum characters needed by a search. |
| void linphone_ldap_params_set_name_attribute | ( | LinphoneLdapParams * | params, |
| const char * | name_attribute | ||
| ) |
List of LDAP attributes to check for the contact name, separated by a comma and the first being the highest priority.
Default value : "sn".
| params | The LinphoneLdapParams object. |
| name_attribute | The comma separated attributes for the search. |
| void linphone_ldap_params_set_password | ( | LinphoneLdapParams * | params, |
| const char * | password | ||
| ) |
The password to pass to server when binding.
Default value : "".
| params | The LinphoneLdapParams object. |
| password | The password to pass to server when binding. |
| void linphone_ldap_params_set_server | ( | LinphoneLdapParams * | params, |
| const char * | server | ||
| ) |
LDAP Server.
eg: ldap:/// for a localhost server or ldap://ldap.example.org/ Default value: "ldap:///". This field is required.
You must use 'ldap' scheme. 'ldaps' for LDAP over SSL is non-standardized and deprecated.
| params | The LinphoneLdapParams object. |
| server | LDAP Server address. |
| void linphone_ldap_params_set_server_certificates_verification_mode | ( | LinphoneLdapParams * | params, |
| LinphoneLdapCertVerificationMode | verify_server_certificates | ||
| ) |
Specify whether the tls server certificate must be verified when connecting to a LDAP server.
Values are LinphoneLdapCertVerificationMode Default value : LinphoneLdapCertVerificationDefault (auto)
| params | The LinphoneLdapParams object. |
| verify_server_certificates | The TLS verification mode from LinphoneLdapCertVerificationMode |
| void linphone_ldap_params_set_sip_attribute | ( | LinphoneLdapParams * | params, |
| const char * | sip_attribute | ||
| ) |
Check these attributes to build the SIP username in address of Friend.
Attributes are separated by a comma. Default value : "mobile,telephoneNumber,homePhone,sn".
| params | The LinphoneLdapParams object. |
| sip_attribute | The comma separated attributes for building Friend. |
| void linphone_ldap_params_set_sip_domain | ( | LinphoneLdapParams * | params, |
| const char * | sip_domain | ||
| ) |
Add the domain to the sip address(sip:username@domain).
By default or if it is empty, the domain will be specify while searching on the current proxy account. Default value : "".
| params | The LinphoneLdapParams object. |
| sip_domain | The SIP domain for the friend. |
| void linphone_ldap_params_set_timeout | ( | LinphoneLdapParams * | params, |
| int | timeout | ||
| ) |
Timeout for requests in seconds.
It limits the time for searchs and the value is passed to Ldap with LDAP_OPT_NETWORK_TIMEOUT. Default value : 5.
| params | The LinphoneLdapParams object. |
| timeout | The timeout in seconds. |
| void linphone_ldap_params_set_timeout_tls_ms | ( | LinphoneLdapParams * | params, |
| int | timeout | ||
| ) |
Timeout for TLS connection in milliseconds.
Default value : 1000.
| params | The LinphoneLdapParams object. |
| timeout | The timeout in milliseconds. |
| bool_t linphone_ldap_params_tls_enabled | ( | const LinphoneLdapParams * | params | ) |
Return if transactions are encrypted by LDAP over TLS(StartTLS).
You must use \'ldap\' scheme. \'ldaps\' for LDAP over SSL is non-standardized and deprecated. StartTLS in an extension to the LDAP protocol which uses the TLS protocol to encrypt communication. It works by establishing a normal - i.e. unsecured - connection with the LDAP server before a handshake negotiation between the server and the web services is carried out. Here, the server sends its certificate to prove its identity before the secure connection is established.
| params | The LinphoneLdapParams object. |
| void linphone_ldap_params_unref | ( | LinphoneLdapParams * | params | ) |
Release a LinphoneLdapParams.
| params | The LinphoneLdapParams object. |
| 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.
| 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 .
| remote_contact_directory | The LinphoneRemoteContactDirectory object. |
| 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.
| remote_contact_directory | The LinphoneRemoteContactDirectory object. |
| int linphone_remote_contact_directory_get_delay | ( | const LinphoneRemoteContactDirectory * | remote_contact_directory | ) |
Gets the delay between each search in milliseconds.
Only available for LinphoneRemoteContactDirectoryTypeLdap
| remote_contact_directory | The LinphoneRemoteContactDirectory object. |
| 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.
| remote_contact_directory | The LinphoneRemoteContactDirectory object. |
| 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.
| remote_contact_directory | The LinphoneRemoteContactDirectory object. |
| 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.
| remote_contact_directory | The LinphoneRemoteContactDirectory object. |
| const char * linphone_remote_contact_directory_get_server_url | ( | const LinphoneRemoteContactDirectory * | remote_contact_directory | ) |
Gets the configured remote contact directory server URL.
| remote_contact_directory | The LinphoneRemoteContactDirectory object. |
| unsigned int linphone_remote_contact_directory_get_timeout | ( | const LinphoneRemoteContactDirectory * | remote_contact_directory | ) |
Gets the timeout (in seconds) after which the query is abandonned.
| remote_contact_directory | The LinphoneRemoteContactDirectory object. |
| LinphoneRemoteContactDirectoryType linphone_remote_contact_directory_get_type | ( | const LinphoneRemoteContactDirectory * | remote_contact_directory | ) |
Gets the type of remote contact directory (LDAP, CardDAV).
| remote_contact_directory | The LinphoneRemoteContactDirectory object. |
| LinphoneRemoteContactDirectory * linphone_remote_contact_directory_ref | ( | LinphoneRemoteContactDirectory * | remote_contact_directory | ) |
Takes a reference on a LinphoneRemoteContactDirectory.
| remote_contact_directory | The LinphoneRemoteContactDirectory object. |
| void linphone_remote_contact_directory_set_delay | ( | LinphoneRemoteContactDirectory * | remote_contact_directory, |
| int | milliseconds | ||
| ) |
Sets the delay between each search in milliseconds.
Only available for LinphoneRemoteContactDirectoryTypeLdap Default value : 500.
| 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.
| 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.
| 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.
| 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.
| 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.
| remote_contact_directory | The LinphoneRemoteContactDirectory object. |
1.9.8