Liblinphone 5.5.0
 
Loading...
Searching...
No Matches
linphone::MessageWaitingIndication Class Reference

#include <message_waiting_indication.hh>

Inheritance diagram for linphone::MessageWaitingIndication:

Public Types

enum class  ContextClass {
  Voice = 0 ,
  Fax = 1 ,
  Pager = 2 ,
  Multimedia = 3 ,
  Text = 4 ,
  None = 5
}
 

Public Member Functions

LINPHONECXX_PUBLIC MessageWaitingIndication (void *ptr, bool takeRef=true)
 
LINPHONECXX_PUBLIC _LinphoneMessageWaitingIndication * cPtr ()
 
LINPHONECXX_PUBLIC std::shared_ptr< const linphone::AddressgetAccountAddress () const
 
LINPHONECXX_PUBLIC void setAccountAddress (const std::shared_ptr< linphone::Address > &address)
 
LINPHONECXX_PUBLIC uint32_t getNbNew () const
 
LINPHONECXX_PUBLIC uint32_t getNbNewUrgent () const
 
LINPHONECXX_PUBLIC uint32_t getNbOld () const
 
LINPHONECXX_PUBLIC uint32_t getNbOldUrgent () const
 
LINPHONECXX_PUBLIC std::list< std::shared_ptr< linphone::MessageWaitingIndicationSummary > > getSummaries () const
 
LINPHONECXX_PUBLIC std::shared_ptr< linphone::MessageWaitingIndicationclone () const
 
LINPHONECXX_PUBLIC std::shared_ptr< const linphone::MessageWaitingIndicationSummarygetSummary (ContextClass contextClass) const
 
LINPHONECXX_PUBLIC bool hasMessageWaiting () const
 
LINPHONECXX_PUBLIC std::shared_ptr< linphone::ContenttoContent () const
 

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.

◆ getNbNew()

LINPHONECXX_PUBLIC uint32_t linphone::MessageWaitingIndication::getNbNew ( ) const

Get the total number of new messages (for all the summaries).

Returns
The total number of new messages.

◆ getNbNewUrgent()

LINPHONECXX_PUBLIC uint32_t linphone::MessageWaitingIndication::getNbNewUrgent ( ) const

Get the total number of new urgent messages (for all the summaries).

Returns
The total number of new urgent messages.

◆ getNbOld()

LINPHONECXX_PUBLIC uint32_t linphone::MessageWaitingIndication::getNbOld ( ) const

Get the total number of old messages (for all the summaries).

Returns
The total number of old messages.

◆ getNbOldUrgent()

LINPHONECXX_PUBLIC uint32_t linphone::MessageWaitingIndication::getNbOldUrgent ( ) const

Get the total number of old urgent messages (for all the summaries).

Returns
The total number of old urgent messages.

◆ 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. A list of MessageWaitingIndicationSummary objects.

◆ 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
contextClassthe 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
addressThe 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: