Object that represents a LDAP connection. More...

#include <ldap.hh>

Inheritance diagram for linphone::Ldap:

Public Types
enum	DebugLevel { DebugLevel::Off = 0, DebugLevel::Verbose = 1 }
	Enum Debug verbosity for OpenLdap. More...

enum	AuthMethod { AuthMethod::Anonymous = 0, AuthMethod::Simple = 1 }
	Enum describing how the authentification will be made. More...

enum	CertVerificationMode { CertVerificationMode::Default = -1, CertVerificationMode::Disabled = 0, CertVerificationMode::Enabled = 1 }
	Enum describing server certificates verification modes. More...

enum	Check { Check::Ok = 0, Check::ServerEmpty = 1, Check::ServerNotUrl = 2, Check::ServerNoScheme = 4, Check::ServerNotLdap = 8, Check::ServerLdaps = 16, Check::BaseObjectEmpty = 32, Check::MissingFields = 64 }
	Enum describing errors in LDAP parameters. More...

Public Member Functions
LINPHONECXX_PUBLIC	Ldap (void *ptr, bool takeRef=true)

LINPHONECXX_PUBLIC _LinphoneLdap *	cPtr ()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::shared_ptr< linphone::Core >	getCore ()
	Get the Core object to which is associated the Ldap. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED int	getIndex () const
	Get the index of the Ldap. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	setIndex (int index)
	Set the index associated to the Ldap. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::shared_ptr< linphone::LdapParams >	getParams ()
	Get the LdapParams as read-only object. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	setParams (const std::shared_ptr< linphone::LdapParams > &params)
	Set the LdapParams used by this Ldap. More...

Static Public Member Functions
LINPHONECXX_PUBLIC static LINPHONECXX_DEPRECATED std::shared_ptr< linphone::Ldap >	newWithParams (const std::shared_ptr< linphone::Core > &lc, const std::shared_ptr< linphone::LdapParams > &params)
	Create a new Ldap, associate it with the LdapParams and store it into the configuration file. More...

Detailed Description

Object that represents a LDAP connection.

Use a LdapParams object to configure it.

Deprecated:: 18/11/2024 Ldap object is no longer used, use RemoteContactDirectory instead.

Member Enumeration Documentation

◆ AuthMethod

enum linphone::Ldap::AuthMethod

strong

Enum describing how the authentification will be made.

Enumerator
Anonymous	Connection without passwords.
Simple	Connection with username/password.

◆ CertVerificationMode

enum linphone::Ldap::CertVerificationMode

strong

Enum describing server certificates verification modes.

Enumerator
Default	Use default value defined on core.
Disabled	Verification is disabled.
Enabled	Verification is enabled.

◆ Check

enum linphone::Ldap::Check

strong

Enum describing errors in LDAP parameters.

Enumerator
Ok	No error.
ServerEmpty	Server field is empty.
ServerNotUrl	The server is not an url.
ServerNoScheme	The server doesn't contain a scheme.
ServerNotLdap	The server is not a LDAP scheme.
ServerLdaps	LDAP over SSL is non-standardized and deprecated: ldaps has been specified.
BaseObjectEmpty	Base Object has been specified.
MissingFields	Some required fields are missing.

◆ DebugLevel

enum linphone::Ldap::DebugLevel

strong

Enum Debug verbosity for OpenLdap.

Enumerator
Off	Set OpenLdap verbosity to none.
Verbose	Set OpenLdap verbosity to debug level.

Member Function Documentation

◆ getCore()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::shared_ptr<linphone::Core> linphone::Ldap::getCore ( )

Get the Core object to which is associated the Ldap.

Returns: The Core object to which is associated the Ldap.

Deprecated:: 18/11/2024 Ldap object is no longer used, use RemoteContactDirectory instead.

◆ getIndex()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED int linphone::Ldap::getIndex ( ) const

Get the index of the Ldap.

Returns: The index of the Ldap

Deprecated:: 18/11/2024 Ldap object is no longer used, use RemoteContactDirectory instead.

◆ getParams()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::shared_ptr<linphone::LdapParams> linphone::Ldap::getParams ( )

Get the LdapParams as read-only object.

To make changes, clone the returned object using LdapParams::clone() method, make your changes on it and apply them using with setParams().

Returns: The LdapParams attached to this ldap.

Deprecated:: 18/11/2024 Ldap object is no longer used, use RemoteContactDirectory instead.

◆ newWithParams()

LINPHONECXX_PUBLIC static LINPHONECXX_DEPRECATED std::shared_ptr<linphone::Ldap> linphone::Ldap::newWithParams	(	const std::shared_ptr< linphone::Core > &	lc,
		const std::shared_ptr< linphone::LdapParams > &	params
	)

static

Create a new Ldap, associate it with the LdapParams and store it into the configuration file.

Parameters

lc	The Core object.
params	The LdapParams object.

Returns: The newly created Ldap object.

Deprecated:: 18/11/2024 Ldap object is no longer used, use RemoteContactDirectory instead.

◆ setIndex()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::Ldap::setIndex ( int index )

Set the index associated to the Ldap.

Parameters

index The index of the Ldap. Can be -1 : it will be determined on save.

Deprecated:: 18/11/2024 Ldap object is no longer used, use RemoteContactDirectory instead.

◆ setParams()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::Ldap::setParams ( const std::shared_ptr< linphone::LdapParams > & params )

Set the LdapParams used by this Ldap.

The parameters will be saved in the configuration file.

Parameters

params The LdapParams object.

Deprecated:: 18/11/2024 Ldap object is no longer used, use RemoteContactDirectory instead.

The documentation for this class was generated from the following file:

ldap.hh

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ AuthMethod

◆ CertVerificationMode

◆ Check

◆ DebugLevel

Member Function Documentation

◆ getCore()

◆ getIndex()

◆ getParams()

◆ newWithParams()

◆ setIndex()

◆ setParams()