Object representing a Message Waiting Indication. More...
#include <message_waiting_indication.hh>
Inheritance diagram for linphone::MessageWaitingIndication:
Public Types | |
| enum | ContextClass { Voice = 0, Fax = 1, Pager = 2, Multimedia = 3, Text = 4, None = 5 } |
| Enum describing the different contexts for the MessageWaitingIndicationSummary. | |
Public Member Functions | |
| LINPHONECXX_PUBLIC | MessageWaitingIndication (void *ptr, bool takeRef=true) |
| LINPHONECXX_PUBLIC _LinphoneMessageWaitingIndication * | cPtr () |
| LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Address > | getAccountAddress () const |
| Get the address of the message account concerned by this message waiting indication. More... | |
| LINPHONECXX_PUBLIC void | setAccountAddress (const std::shared_ptr< linphone::Address > &address) |
| Set the address of the message account concerned by this message waiting indication. More... | |
| LINPHONECXX_PUBLIC std::list< std::shared_ptr< linphone::MessageWaitingIndicationSummary > > | getSummaries () const |
| Get the message waiting indication summaries. More... | |
| LINPHONECXX_PUBLIC std::shared_ptr< linphone::MessageWaitingIndication > | clone () const |
| Instantiate a new message waiting indication with values from source. More... | |
| LINPHONECXX_PUBLIC std::shared_ptr< const linphone::MessageWaitingIndicationSummary > | getSummary (ContextClass contextClass) const |
| Get the message waiting indication summary for a given context class. More... | |
| LINPHONECXX_PUBLIC bool | hasMessageWaiting () const |
| Tells whether there are messages waiting or not. More... | |
| LINPHONECXX_PUBLIC std::shared_ptr< linphone::Content > | toContent () const |
| Get a Content object to put in a NOTIFY message from a MessageWaitingIndication object. More... | |
Detailed Description
Object representing a Message Waiting Indication.
Member Function Documentation
◆ clone()
| LINPHONECXX_PUBLIC std::shared_ptr<linphone::MessageWaitingIndication> linphone::MessageWaitingIndication::clone | ( | ) | const |
Instantiate a new message waiting indication with values from source.
- Returns
- The newly created MessageWaitingIndication object.
◆ getAccountAddress()
| LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> linphone::MessageWaitingIndication::getAccountAddress | ( | ) | const |
Get the address of the message account concerned by this message waiting indication.
- Returns
- The address of the message account concerned by this message waiting indication.
◆ getSummaries()
| LINPHONECXX_PUBLIC std::list<std::shared_ptr<linphone::MessageWaitingIndicationSummary> > linphone::MessageWaitingIndication::getSummaries | ( | ) | const |
Get the message waiting indication summaries.
- Returns
- The message waiting indication summaries.
◆ getSummary()
| LINPHONECXX_PUBLIC std::shared_ptr<const linphone::MessageWaitingIndicationSummary> linphone::MessageWaitingIndication::getSummary | ( | ContextClass | contextClass | ) | const |
Get the message waiting indication summary for a given context class.
- Parameters
-
contextClass the ContextClass for which we want to get the summary.
- Returns
- The MessageWaitingIndicationSummary for the given context class.
◆ hasMessageWaiting()
| LINPHONECXX_PUBLIC bool linphone::MessageWaitingIndication::hasMessageWaiting | ( | ) | const |
Tells whether there are messages waiting or not.
- Returns
- true if there are waiting messages, false otherwise.
◆ setAccountAddress()
| LINPHONECXX_PUBLIC void linphone::MessageWaitingIndication::setAccountAddress | ( | const std::shared_ptr< linphone::Address > & | address | ) |
Set the address of the message account concerned by this message waiting indication.
- Parameters
-
address The address of the message account concerned by this message waiting indication.
◆ toContent()
| LINPHONECXX_PUBLIC std::shared_ptr<linphone::Content> linphone::MessageWaitingIndication::toContent | ( | ) | const |
Get a Content object to put in a NOTIFY message from a MessageWaitingIndication object.
- Returns
- The Content to put in a NOTIFY message.
The documentation for this class was generated from the following file:
- message_waiting_indication.hh
