EdgeVisDecoderSDK::PhoneNotificationDetails Class Reference
Detailed Description
User settings can be configure on the server for notifications.
This class manages the users phone settings for SMS notifications
Availability
Available in version 7.1 of Decoder SDK. Requires a server version greater than 7.0
#include <PhoneNotificationDetails.h>
Public Member Functions | |
| DB_EDGEVIS_SDK std::wstring | GetPhoneNumber () |
| Get the phone number for the current user. More... | |
| DB_EDGEVIS_SDK bool | IsEnabledForAlarms () |
| Get the is enabled flag for the users phone number. More... | |
| DB_EDGEVIS_SDK bool | SetPhoneNumber (std::wstring phoneNumber) |
| Sets the phone number for the user. More... | |
| DB_EDGEVIS_SDK void | SetEnabledForAlarms (bool enable) |
| Enables the phone number for the user. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::PhoneNotificationDetails::GetPhoneNumber | ( | ) |
Get the phone number for the current user.
- Returns
- The users phone number
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::PhoneNotificationDetails::IsEnabledForAlarms | ( | ) |
Get the is enabled flag for the users phone number.
- Returns
- The users phone number is enabled for notifications
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::PhoneNotificationDetails::SetPhoneNumber | ( | std::wstring | phoneNumber | ) |
Sets the phone number for the user.
- Parameters
-
phoneNumber The users phone number.
- Returns
- True if the phone number has been set
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::PhoneNotificationDetails::SetEnabledForAlarms | ( | bool | enable | ) |
Enables the phone number for the user.
- Parameters
-
enable Enables the phone number for notifications.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/PhoneNotificationDetails.h