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