The LinphoneSearchResult object represents a result of a search. More...
#include <search_result.hh>
Inheritance diagram for linphone::SearchResult:
Public Member Functions | |
| SearchResult (void *ptr, bool takeRef=true) | |
| LINPHONECXX_PUBLIC _LinphoneSearchResult * | cPtr () |
| LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Address > | getAddress () const |
| Gets the address of the search result if any. More... | |
| LINPHONECXX_PUBLIC int | getCapabilities () const |
| Returns the capabilities mask of the search result. More... | |
| LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Friend > | getFriend () const |
| Gets the friend of the search result if any. More... | |
| LINPHONECXX_PUBLIC std::string | getPhoneNumber () const |
| Gets the phone number of the search result if any. More... | |
| LINPHONECXX_PUBLIC unsigned int | getWeight () const |
| Gets the weight of the search result. More... | |
| LINPHONECXX_PUBLIC bool | hasCapability (linphone::FriendCapability capability) const |
| Returns whether or not the search result has the given capability. More... | |
Detailed Description
The LinphoneSearchResult object represents a result of a search.
Member Function Documentation
◆ getAddress()
| LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> linphone::SearchResult::getAddress | ( | ) | const |
Gets the address of the search result if any.
- Returns
- The associed Address or nullptr.
◆ getCapabilities()
| LINPHONECXX_PUBLIC int linphone::SearchResult::getCapabilities | ( | ) | const |
Returns the capabilities mask of the search result.
- Returns
- the capabilities mask associated to the search result
◆ getFriend()
| LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Friend> linphone::SearchResult::getFriend | ( | ) | const |
Gets the friend of the search result if any.
- Returns
- The associated Friend or nullptr.
◆ getPhoneNumber()
| LINPHONECXX_PUBLIC std::string linphone::SearchResult::getPhoneNumber | ( | ) | const |
Gets the phone number of the search result if any.
- Returns
- The associed phone number or nullptr.
◆ getWeight()
| LINPHONECXX_PUBLIC unsigned int linphone::SearchResult::getWeight | ( | ) | const |
Gets the weight of the search result.
- Returns
- the result weight
◆ hasCapability()
| LINPHONECXX_PUBLIC bool linphone::SearchResult::hasCapability | ( | linphone::FriendCapability | capability | ) | const |
Returns whether or not the search result has the given capability.
- Parameters
-
capability the FriendCapability to check
- Returns
- true if it has the capability, false otherwise.
The documentation for this class was generated from the following file:
- search_result.hh
