Detailed Description
A CamsNotification object contains all of the information associated with a CAMS notification either received at the time of generation from the server via the IServerEventListener interface or retrieved from the CamsNotificationManager via the GetNotifications method.
This includes information on the current state, previous state and the source events that resulted in the notification being generated.
Availability
Available in version 6.7.0 of Decoder SDK. Requires a server version greater than 6.5
#include <CamsNotification.h>
Public Member Functions | |
| DB_EDGEVIS_SDK int64_t | GetId () const |
| Retrieve the unique ID for this notification as generated by CAMS. More... | |
| DB_EDGEVIS_SDK std::wstring | GetRule () const |
| Retrieve the unique ID of the CAMS rule that generated this notification. More... | |
| DB_EDGEVIS_SDK std::vector< CamsNotificationEventDesc > | GetEvents () const |
| Retrieve the list of source encoder events that caused the CAMS rule to generate this notification. More... | |
| DB_EDGEVIS_SDK std::vector< CamsNotificationAttachmentInfo > | GetAttachments () const |
| Retrieve the list of attachments associated with this CAMS notification. More... | |
| DB_EDGEVIS_SDK int64_t | GetTime () const |
| Retrieve the timestamp that the CAMS rule generated this notification. More... | |
| DB_EDGEVIS_SDK std::vector< std::wstring > | GetToList () const |
| Retrieve the list of EdgeVis users who this notification was sent to. More... | |
| DB_EDGEVIS_SDK ECamsNotificationState | GetState () const |
| Retrieve the current state of this notification. More... | |
| DB_EDGEVIS_SDK std::wstring | GetSubject () const |
| Retrieve the subject for this notification. More... | |
| DB_EDGEVIS_SDK std::wstring | GetContent () const |
| Retrieve the message body for this notification. More... | |
| DB_EDGEVIS_SDK ECamsNotificationState | GetPreviousState () const |
| Retrieve the previous state of this notification. More... | |
| DB_EDGEVIS_SDK std::wstring | GetEncoderUUID () const |
| Retrieve the UUID of the Encoder associated with this rule if applicable. More... | |
| DB_EDGEVIS_SDK std::wstring | GetDeviceUUID () const |
| Retrieve the UUID of the Device associated with this rule if applicable. More... | |
| DB_EDGEVIS_SDK bool | UpdateStateFromBulkNotification (int64_t id, ECamsNotificationState old_state, ECamsNotificationState new_state) |
| Update the state of this notification based on receiving a bulk notification update from the Server. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::CamsNotification::GetId | ( | ) | const |
Retrieve the unique ID for this notification as generated by CAMS.
- Returns
- The unique ID assigned to this notification.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CamsNotification::GetRule | ( | ) | const |
Retrieve the unique ID of the CAMS rule that generated this notification.
- Returns
- The unique ID of CAMS rule that generated this notification.
| DB_EDGEVIS_SDK std::vector<CamsNotificationEventDesc> EdgeVisDecoderSDK::CamsNotification::GetEvents | ( | ) | const |
Retrieve the list of source encoder events that caused the CAMS rule to generate this notification.
- Returns
- The list of source events from the encoder.
| DB_EDGEVIS_SDK std::vector<CamsNotificationAttachmentInfo> EdgeVisDecoderSDK::CamsNotification::GetAttachments | ( | ) | const |
Retrieve the list of attachments associated with this CAMS notification.
- Returns
- The list of attachments.
| DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::CamsNotification::GetTime | ( | ) | const |
Retrieve the timestamp that the CAMS rule generated this notification.
- Returns
- The UTC time stamp for for when the notification was generated by CAMS.
| DB_EDGEVIS_SDK std::vector<std::wstring> EdgeVisDecoderSDK::CamsNotification::GetToList | ( | ) | const |
Retrieve the list of EdgeVis users who this notification was sent to.
- Returns
- The list of EdgeVis user names this notification was sent to.
| DB_EDGEVIS_SDK ECamsNotificationState EdgeVisDecoderSDK::CamsNotification::GetState | ( | ) | const |
Retrieve the current state of this notification.
- Returns
- The current ECamsNotificationState for this notification.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CamsNotification::GetSubject | ( | ) | const |
Retrieve the subject for this notification.
The format of this string is dictated by the CAMS rule.
- Returns
- The subject string for this CAMS notification.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CamsNotification::GetContent | ( | ) | const |
Retrieve the message body for this notification.
The format of this string is dictated by the CAMS rule.
- Returns
- The message body string for this CAMS notification.
| DB_EDGEVIS_SDK ECamsNotificationState EdgeVisDecoderSDK::CamsNotification::GetPreviousState | ( | ) | const |
Retrieve the previous state of this notification.
- Returns
- The previous ECamsNotificationState for this notification.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CamsNotification::GetEncoderUUID | ( | ) | const |
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CamsNotification::GetDeviceUUID | ( | ) | const |
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::CamsNotification::UpdateStateFromBulkNotification | ( | int64_t | id, |
| ECamsNotificationState | old_state, | ||
| ECamsNotificationState | new_state | ||
| ) |
Update the state of this notification based on receiving a bulk notification update from the Server.
This will only update the state on this notification object locally to reflect the updated state of this notification at the Server.
- Parameters
-
id The ID of the notification to change. If this does not match the ID of this notification the request will fail. old_state The current state of the notification to change. If this does not match the current state of this notification the request will fail. new_state The new state to apply to this notification.
- Returns
- True if successful, false if the request failed.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/CamsNotification.h