Object that represents a remote contact directory such as a LDAP or CardDAV server; used as a MagicSearch source. More...
#include <remote_contact_directory.hh>
Public Types | |
| enum | Type { Type::CardDav = 0, Type::Ldap = 1 } |
| Enum describing the type of RemoteContactDirectory (currently CardDAV or LDAP). More... | |
Public Member Functions | |
| LINPHONECXX_PUBLIC | RemoteContactDirectory (void *ptr, bool takeRef=true) |
| LINPHONECXX_PUBLIC _LinphoneRemoteContactDirectory * | cPtr () |
| LINPHONECXX_PUBLIC std::shared_ptr< linphone::CardDavParams > | getCardDavParams () const |
| Gets the CardDAV params if getType() returns CardDAV. More... | |
| LINPHONECXX_PUBLIC std::shared_ptr< linphone::LdapParams > | getLdapParams () const |
| Gets the LDAP params if getType() returns LDAP. More... | |
| LINPHONECXX_PUBLIC unsigned int | getLimit () const |
| Gets the maximum number of results to fetch, 0 means no limit. More... | |
| LINPHONECXX_PUBLIC void | setLimit (unsigned int limit) |
| Sets the maximum number of results to fetch, 0 means no limit. More... | |
| LINPHONECXX_PUBLIC unsigned int | getMinCharacters () const |
| Gets the minimum number of characters to have before sending the query to the server. More... | |
| LINPHONECXX_PUBLIC void | setMinCharacters (unsigned int min) |
| Sets the minimum number of characters to have before sending the query to the server. More... | |
| LINPHONECXX_PUBLIC std::string | getServerUrl () const |
| Gets the configured remote contact directory server URL. More... | |
| LINPHONECXX_PUBLIC void | setServerUrl (const std::string &serverUrl) |
| Sets the server URL to use to reach the remote contact directory server. More... | |
| LINPHONECXX_PUBLIC unsigned int | getTimeout () const |
| Gets the timeout (in seconds) after which the query is abandonned. More... | |
| LINPHONECXX_PUBLIC void | setTimeout (unsigned int seconds) |
| Sets the timeout (in seconds) after which the query is abandonned. More... | |
| LINPHONECXX_PUBLIC Type | getType () const |
| Gets the type of remote contact directory (LDAP, CardDAV). More... | |
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
|
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
◆ getCardDavParams()
| LINPHONECXX_PUBLIC std::shared_ptr<linphone::CardDavParams> linphone::RemoteContactDirectory::getCardDavParams | ( | ) | const |
Gets the CardDAV params if getType() returns CardDAV.
- Returns
- the CardDavParams or nullptr if not of CardDAV type.
◆ getLdapParams()
| LINPHONECXX_PUBLIC std::shared_ptr<linphone::LdapParams> linphone::RemoteContactDirectory::getLdapParams | ( | ) | const |
Gets the LDAP params 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.
◆ 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
