Liblinphone
5.3.0
|
Object that represents an alert. More...
#include <alert.hh>
Public Member Functions | |
LINPHONECXX_PUBLIC | Alert (void *ptr, bool takeRef=true) |
LINPHONECXX_PUBLIC _LinphoneAlert * | cPtr () |
LINPHONECXX_PUBLIC void | addListener (const std::shared_ptr< AlertListener > &listener) |
Add an application listener to the Alert instance. More... | |
LINPHONECXX_PUBLIC void | removeListener (const std::shared_ptr< AlertListener > &listener) |
Remove a previously added listener from the Alert instance. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Call > | getCall () const |
Return the call from the alert. More... | |
LINPHONECXX_PUBLIC time_t | getEndTime () const |
Return the end time of the alert. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Dictionary > | getInformations () const |
Return more informations about the alerts. More... | |
LINPHONECXX_PUBLIC time_t | getStartTime () const |
Return the start time of the alert. More... | |
LINPHONECXX_PUBLIC bool | getState () const |
Return the state of the alert. More... | |
LINPHONECXX_PUBLIC Type | getType () const |
Return the type of the alert. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::Alert > | clone () const |
Clone the given alert. More... | |
LINPHONECXX_PUBLIC void | notifyOnTerminated () |
Notify the alert if it is terminated. | |
Static Public Member Functions | |
static LINPHONECXX_PUBLIC std::string | typeToString (Type type) |
Provide a string describing the alert type. More... | |
Object that represents an alert.
Alerts are raised at run-time when particular conditions are met, for example bad network quality. The full list of available alert types is described by the Type enum. An application is notified of new alerts through the CoreListener interface. Once raised, the application may use the AlertListener interface to get notified when the alert stops. For each kind of alert, a Dictionary is filled with relevant informations, returned by getInformations(). The keys available are documented per-type in Type enum.
|
strong |
All kinds of alerts.
LINPHONECXX_PUBLIC void linphone::Alert::addListener | ( | const std::shared_ptr< AlertListener > & | listener | ) |
Add an application listener to the Alert instance.
listener | the application listener |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Alert> linphone::Alert::clone | ( | ) | const |
Clone the given alert.
LINPHONECXX_PUBLIC std::shared_ptr<linphone::Call> linphone::Alert::getCall | ( | ) | const |
Return the call from the alert.
LINPHONECXX_PUBLIC time_t linphone::Alert::getEndTime | ( | ) | const |
Return the end time of the alert.
LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Dictionary> linphone::Alert::getInformations | ( | ) | const |
Return more informations about the alerts.
LINPHONECXX_PUBLIC time_t linphone::Alert::getStartTime | ( | ) | const |
Return the start time of the alert.
LINPHONECXX_PUBLIC bool linphone::Alert::getState | ( | ) | const |
Return the state of the alert.
LINPHONECXX_PUBLIC Type linphone::Alert::getType | ( | ) | const |
Return the type of the alert.
LINPHONECXX_PUBLIC void linphone::Alert::removeListener | ( | const std::shared_ptr< AlertListener > & | listener | ) |
Remove a previously added listener from the Alert instance.
listener | the application listener |
|
static |