Policy to use to send/receive instant messaging composing/delivery/display notifications. More...
#include <im_notif_policy.hh>
Inheritance diagram for linphone::ImNotifPolicy:
Public Member Functions | |
| ImNotifPolicy (void *ptr, bool takeRef=true) | |
| LINPHONECXX_PUBLIC _LinphoneImNotifPolicy * | cPtr () |
| LINPHONECXX_PUBLIC bool | getRecvImdnDelivered () const |
| Tell whether imdn delivered notifications are being notified when received. More... | |
| LINPHONECXX_PUBLIC void | setRecvImdnDelivered (bool enable) |
| Enable imdn delivered notifications receiving. More... | |
| LINPHONECXX_PUBLIC bool | getRecvImdnDisplayed () const |
| Tell whether imdn displayed notifications are being notified when received. More... | |
| LINPHONECXX_PUBLIC void | setRecvImdnDisplayed (bool enable) |
| Enable imdn displayed notifications receiving. More... | |
| LINPHONECXX_PUBLIC bool | getRecvIsComposing () const |
| Tell whether is_composing notifications are being notified when received. More... | |
| LINPHONECXX_PUBLIC void | setRecvIsComposing (bool enable) |
| Enable is_composing notifications receiving. More... | |
| LINPHONECXX_PUBLIC bool | getSendImdnDelivered () const |
| Tell whether imdn delivered notifications are being sent. More... | |
| LINPHONECXX_PUBLIC void | setSendImdnDelivered (bool enable) |
| Enable imdn delivered notifications sending. More... | |
| LINPHONECXX_PUBLIC bool | getSendImdnDisplayed () const |
| Tell whether imdn displayed notifications are being sent. More... | |
| LINPHONECXX_PUBLIC void | setSendImdnDisplayed (bool enable) |
| Enable imdn displayed notifications sending. More... | |
| LINPHONECXX_PUBLIC bool | getSendIsComposing () const |
| Tell whether is_composing notifications are being sent. More... | |
| LINPHONECXX_PUBLIC void | setSendIsComposing (bool enable) |
| Enable is_composing notifications sending. More... | |
| LINPHONECXX_PUBLIC void | clear () |
| Clear an IM notif policy (deactivate all receiving and sending of notifications). | |
| LINPHONECXX_PUBLIC void | enableAll () |
| Enable all receiving and sending of notifications. | |
Detailed Description
Policy to use to send/receive instant messaging composing/delivery/display notifications.
The sending of this information is done as in the RFCs 3994 (is_composing) and 5438 (imdn delivered/displayed).
Member Function Documentation
◆ getRecvImdnDelivered()
| LINPHONECXX_PUBLIC bool linphone::ImNotifPolicy::getRecvImdnDelivered | ( | ) | const |
Tell whether imdn delivered notifications are being notified when received.
- Returns
- Boolean value telling whether imdn delivered notifications are being notified when received.
◆ getRecvImdnDisplayed()
| LINPHONECXX_PUBLIC bool linphone::ImNotifPolicy::getRecvImdnDisplayed | ( | ) | const |
Tell whether imdn displayed notifications are being notified when received.
- Returns
- Boolean value telling whether imdn displayed notifications are being notified when received.
◆ getRecvIsComposing()
| LINPHONECXX_PUBLIC bool linphone::ImNotifPolicy::getRecvIsComposing | ( | ) | const |
Tell whether is_composing notifications are being notified when received.
- Returns
- Boolean value telling whether is_composing notifications are being notified when received.
◆ getSendImdnDelivered()
| LINPHONECXX_PUBLIC bool linphone::ImNotifPolicy::getSendImdnDelivered | ( | ) | const |
Tell whether imdn delivered notifications are being sent.
- Returns
- Boolean value telling whether imdn delivered notifications are being sent.
◆ getSendImdnDisplayed()
| LINPHONECXX_PUBLIC bool linphone::ImNotifPolicy::getSendImdnDisplayed | ( | ) | const |
Tell whether imdn displayed notifications are being sent.
- Returns
- Boolean value telling whether imdn displayed notifications are being sent.
◆ getSendIsComposing()
| LINPHONECXX_PUBLIC bool linphone::ImNotifPolicy::getSendIsComposing | ( | ) | const |
Tell whether is_composing notifications are being sent.
- Returns
- Boolean value telling whether is_composing notifications are being sent.
◆ setRecvImdnDelivered()
| LINPHONECXX_PUBLIC void linphone::ImNotifPolicy::setRecvImdnDelivered | ( | bool | enable | ) |
Enable imdn delivered notifications receiving.
- Parameters
-
enable Boolean value telling whether to notify received imdn delivered notifications.
◆ setRecvImdnDisplayed()
| LINPHONECXX_PUBLIC void linphone::ImNotifPolicy::setRecvImdnDisplayed | ( | bool | enable | ) |
Enable imdn displayed notifications receiving.
- Parameters
-
enable Boolean value telling whether to notify received imdn displayed notifications.
◆ setRecvIsComposing()
| LINPHONECXX_PUBLIC void linphone::ImNotifPolicy::setRecvIsComposing | ( | bool | enable | ) |
Enable is_composing notifications receiving.
- Parameters
-
enable Boolean value telling whether to notify received is_composing notifications.
◆ setSendImdnDelivered()
| LINPHONECXX_PUBLIC void linphone::ImNotifPolicy::setSendImdnDelivered | ( | bool | enable | ) |
Enable imdn delivered notifications sending.
- Parameters
-
enable Boolean value telling whether to send imdn delivered notifications.
◆ setSendImdnDisplayed()
| LINPHONECXX_PUBLIC void linphone::ImNotifPolicy::setSendImdnDisplayed | ( | bool | enable | ) |
Enable imdn displayed notifications sending.
- Parameters
-
enable Boolean value telling whether to send imdn displayed notifications.
◆ setSendIsComposing()
| LINPHONECXX_PUBLIC void linphone::ImNotifPolicy::setSendIsComposing | ( | bool | enable | ) |
Enable is_composing notifications sending.
- Parameters
-
enable Boolean value telling whether to send is_composing notifications.
The documentation for this class was generated from the following file:
- im_notif_policy.hh
