linphone::RemoteContactDirectory Class Reference

#include <remote_contact_directory.hh>

Inheritance diagram for linphone::RemoteContactDirectory:

Public Types
enum class	Type {   CardDav = 0 ,   Ldap = 1 }

Public Member Functions
LINPHONECXX_PUBLIC	RemoteContactDirectory (void *ptr, bool takeRef=true)
LINPHONECXX_PUBLIC _LinphoneRemoteContactDirectory *	cPtr ()
LINPHONECXX_PUBLIC std::shared_ptr< linphone::CardDavParams >	getCardDavRemoteContactDirectory () const
LINPHONECXX_PUBLIC int	getDelay () const
LINPHONECXX_PUBLIC void	setDelay (int milliseconds)
LINPHONECXX_PUBLIC std::shared_ptr< linphone::LdapParams >	getLdapRemoteContactDirectory () const
LINPHONECXX_PUBLIC unsigned int	getLimit () const
LINPHONECXX_PUBLIC void	setLimit (unsigned int limit)
LINPHONECXX_PUBLIC unsigned int	getMinCharacters () const
LINPHONECXX_PUBLIC void	setMinCharacters (unsigned int min)
LINPHONECXX_PUBLIC std::string	getServerUrl () const
LINPHONECXX_PUBLIC void	setServerUrl (const std::string &serverUrl)
LINPHONECXX_PUBLIC unsigned int	getTimeout () const
LINPHONECXX_PUBLIC void	setTimeout (unsigned int seconds)
LINPHONECXX_PUBLIC Type	getType () const
LINPHONECXX_PUBLIC void	enable (bool value)
LINPHONECXX_PUBLIC bool	enabled () const

Detailed Description

Object that represents a remote contact directory such as a LDAP or CardDAV server; used as a MagicSearch source.

Member Enumeration Documentation

Type

enum class linphone::RemoteContactDirectory::Type

strong

Enum describing the type of RemoteContactDirectory (currently CardDAV or LDAP).

Enumerator
CardDav	Remote contact directory will use CardDavParams.
Ldap	Remote contact directory will use LdapParams.

Member Function Documentation

enable()

LINPHONECXX_PUBLIC void linphone::RemoteContactDirectory::enable

(

bool

value

)

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

Parameters

value

A boolean.

enabled()

LINPHONECXX_PUBLIC bool linphone::RemoteContactDirectory::enabled

(

)

const

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

usable for searches with the MagicSearch .

Returns

a boolean.

getCardDavRemoteContactDirectory()

LINPHONECXX_PUBLIC std::shared_ptr< linphone::CardDavParams > linphone::RemoteContactDirectory::getCardDavRemoteContactDirectory

(

)

const

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

Returns

the CardDavParams or nullptr if not of CardDAV type.

getDelay()

LINPHONECXX_PUBLIC int linphone::RemoteContactDirectory::getDelay

(

)

const

Get the delay between each search in milliseconds.

Only available for Type::Ldap

Returns

The delay in milliseconds.

getLdapRemoteContactDirectory()

LINPHONECXX_PUBLIC std::shared_ptr< linphone::LdapParams > linphone::RemoteContactDirectory::getLdapRemoteContactDirectory

(

)

const

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

Returns

the LdapParams or nullptr if not of LDAP type.

getLimit()

LINPHONECXX_PUBLIC unsigned int linphone::RemoteContactDirectory::getLimit

(

)

const

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

Returns

the maximum number of results, 0 means no limit.

getMinCharacters()

LINPHONECXX_PUBLIC unsigned int linphone::RemoteContactDirectory::getMinCharacters

(

)

const

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

Returns

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

getServerUrl()

LINPHONECXX_PUBLIC std::string linphone::RemoteContactDirectory::getServerUrl

(

)

const

Gets the configured remote contact directory server URL.

Returns

the remote contact directory server URL.

getTimeout()

LINPHONECXX_PUBLIC unsigned int linphone::RemoteContactDirectory::getTimeout

(

)

const

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

Returns

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

getType()

LINPHONECXX_PUBLIC Type linphone::RemoteContactDirectory::getType

(

)

const

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

Returns

the Type of this remote contact directory.

setDelay()

LINPHONECXX_PUBLIC void linphone::RemoteContactDirectory::setDelay

(

int

milliseconds

)

Set the delay between each search in milliseconds.

Only available for Type::Ldap Default value : 500.

Parameters

milliseconds

The timeout in milliseconds.

setLimit()

LINPHONECXX_PUBLIC void linphone::RemoteContactDirectory::setLimit

(

unsigned int

limit

)

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

Parameters

limit

the maximum number of results to return.

setMinCharacters()

LINPHONECXX_PUBLIC void linphone::RemoteContactDirectory::setMinCharacters

(

unsigned int

min

)

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

Parameters

min	the minimum characters to have in user input filter before sending the query.

setServerUrl()

LINPHONECXX_PUBLIC void linphone::RemoteContactDirectory::setServerUrl

(

const std::string &

serverUrl

)

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

Parameters

serverUrl

the remote contact directory server URL.

setTimeout()

LINPHONECXX_PUBLIC void linphone::RemoteContactDirectory::setTimeout

(

unsigned int

seconds

)

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

Parameters

seconds

the number of seconds before considering the query as timed-out.

---

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

• remote_contact_directory.hh