Liblinphone  5.4.0
Public Member Functions | List of all members
linphone::CardDavParams Class Reference

The CardDavParams object represents a remote CardDAV server used by MagicSearch as a plugin source. More...

#include <card_dav_params.hh>

Inheritance diagram for linphone::CardDavParams:

Public Member Functions

LINPHONECXX_PUBLIC CardDavParams (void *ptr, bool takeRef=true)
 
LINPHONECXX_PUBLIC _LinphoneCardDavParams * cPtr ()
 
LINPHONECXX_PUBLIC std::list< std::string > getDomainFields () const
 Gets the list of vCard RFC fields to use to match the domain filter on. More...
 
LINPHONECXX_PUBLIC void setDomainFields (const std::list< std::string > &list)
 Sets the list of vCard RFC fields to use to match the domain filter on. More...
 
LINPHONECXX_PUBLIC bool getUseExactMatchPolicy () const
 Gets the matching policy: true if the remote vCard value must match the filter exactly, false if it only needs to contain the filter. More...
 
LINPHONECXX_PUBLIC void setUseExactMatchPolicy (bool exactMatch)
 Sets the matching policy: true if the remote vCard value must match the filter exactly, false if it only needs to contain the filter. More...
 
LINPHONECXX_PUBLIC std::list< std::string > getUserInputFields () const
 Gets the list of vCard RFC fields to use to match user input text on. More...
 
LINPHONECXX_PUBLIC void setUserInputFields (const std::list< std::string > &list)
 Sets the list of vCard RFC fields to use to match user input text on. More...
 
LINPHONECXX_PUBLIC std::shared_ptr< linphone::CardDavParamsclone () const
 Instantiates a new CardDavParams with values from source. More...
 

Detailed Description

The CardDavParams object represents a remote CardDAV server used by MagicSearch as a plugin source.

Member Function Documentation

◆ clone()

LINPHONECXX_PUBLIC std::shared_ptr<linphone::CardDavParams> linphone::CardDavParams::clone ( ) const

Instantiates a new CardDavParams with values from source.

Returns
The newly created CardDavParams object.

◆ getDomainFields()

LINPHONECXX_PUBLIC std::list<std::string> linphone::CardDavParams::getDomainFields ( ) const

Gets the list of vCard RFC fields to use to match the domain filter on.

For example you can use "IMPP".

Returns
The list of vCard fields to make the query on using domain filter.

◆ getUseExactMatchPolicy()

LINPHONECXX_PUBLIC bool linphone::CardDavParams::getUseExactMatchPolicy ( ) const

Gets the matching policy: true if the remote vCard value must match the filter exactly, false if it only needs to contain the filter.

Returns
The matching policy: true if the remote vCard value must match the filter exactly, false if it only needs to contain the filter.

◆ getUserInputFields()

LINPHONECXX_PUBLIC std::list<std::string> linphone::CardDavParams::getUserInputFields ( ) const

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...

Returns
The list of vCard fields to make the query on using user input.

◆ setDomainFields()

LINPHONECXX_PUBLIC void linphone::CardDavParams::setDomainFields ( const std::list< std::string > &  list)

Sets the list of vCard RFC fields to use to match the domain filter on.

For example you can use "IMPP".

Parameters
listthe list of vCard RFC fields to use to match the domain filter on.

◆ setUseExactMatchPolicy()

LINPHONECXX_PUBLIC void linphone::CardDavParams::setUseExactMatchPolicy ( bool  exactMatch)

Sets the matching policy: true if the remote vCard value must match the filter exactly, false if it only needs to contain the filter.

Parameters
exactMatchthe policy to use: true if the remote vCard value must match the filter exactly, false if it only needs to contain the filter.

◆ setUserInputFields()

LINPHONECXX_PUBLIC void linphone::CardDavParams::setUserInputFields ( const std::list< std::string > &  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...

Parameters
listthe list of vCard RFC fields to use to match user input text on.

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