Detailed Description
A CamsBulkNotification object contains CAMS state change information for multiple CAMS notifications.
Bulk state change notifications are received from the server via the IServerEventListener interface. This includes information on the current state, previous state and the IDs of the notifications being changed.
Availability
Available in version 6.7.0 of Decoder SDK. Requires a server version greater than 6.5
#include <CamsBulkNotification.h>
Public Member Functions | |
| DB_EDGEVIS_SDK ECamsNotificationState | GetFromState () const |
| Retrieve the original state of the notifications that have had the bulk state change applied to them. More... | |
| DB_EDGEVIS_SDK ECamsNotificationState | GetToState () const |
| Retrieve the new state of the notifications that have had the bulk state change applied to them. More... | |
| DB_EDGEVIS_SDK std::vector< CamsNotificationStateDesc > | GetStates () const |
| The total number of notifications in each state available on the Server. More... | |
| DB_EDGEVIS_SDK std::vector< int64_t > | GetUpdatedIds () const |
| Retrieve the list of notification IDs that have had the bulk state change applied to them. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK ECamsNotificationState EdgeVisDecoderSDK::CamsBulkNotification::GetFromState | ( | ) | const |
Retrieve the original state of the notifications that have had the bulk state change applied to them.
- Returns
- The original ECamsNotificationstate of the notifications.
| DB_EDGEVIS_SDK ECamsNotificationState EdgeVisDecoderSDK::CamsBulkNotification::GetToState | ( | ) | const |
Retrieve the new state of the notifications that have had the bulk state change applied to them.
- Returns
- The new ECamsNotificationstate of the notifications.
| DB_EDGEVIS_SDK std::vector<CamsNotificationStateDesc> EdgeVisDecoderSDK::CamsBulkNotification::GetStates | ( | ) | const |
The total number of notifications in each state available on the Server.
- Returns
- A list of CamsNotificationStateDesc objects that indicate the number of server-side notifications in each ECamsNotificationState.
| DB_EDGEVIS_SDK std::vector<int64_t> EdgeVisDecoderSDK::CamsBulkNotification::GetUpdatedIds | ( | ) | const |
Retrieve the list of notification IDs that have had the bulk state change applied to them.
- Returns
- The uniqe IDs of the notifications that have changed state.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/CamsBulkNotification.h