Detailed Description

The CamsNotificationManager facilitates interactions with CAMS notifications stored at the server.

The CamsNotificationManager allows historical notifications to be pulled from the server and also to apply state changes to notifications.

Available in version 6.7.0 of Decoder SDK. Requires a server version greater than 6.5

Public Member Functions
DB_EDGEVIS_SDK OpResult	GetNotifications (int64_t startId, CamsGetNotificationsResult &notifications)
	Retrieve existing CAMS notifications from the Server. More...

DB_EDGEVIS_SDK OpResult	GetNotificationsForState (int64_t startId, std::vector< ECamsNotificationState > states, CamsGetNotificationsResult &notifications)
	Retrieve existing CAMS notifications with the state specified from the Server. More...

DB_EDGEVIS_SDK OpResult	UpdateCamsNotifications (const std::vector< int64_t > &ids, const ECamsNotificationState old_state, const ECamsNotificationState new_state)
	Change the state of the specified CAMS notifications. More...

DB_EDGEVIS_SDK OpResult	BulkUpdateCamsNotifications (const int64_t &start_id, const int64_t &end_id, const ECamsNotificationState old_state, const ECamsNotificationState new_state)
	Change the state of the CAMS notifications with IDs in the specified range. More...

Member Function Documentation

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::CamsNotificationManager::GetNotifications	(	int64_t	startId,
		CamsGetNotificationsResult &	notifications
	)

Retrieve existing CAMS notifications from the Server.

Notifications are retrieved in pages of size 30.

Parameters

startId	The notification ID at the start of the page to retrieve. Specifying an ID of -1 will retrieve the 30 most recent notifications available.
notifications	CamsGetNotificationsResult object containing the relevant notification information.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::CamsNotificationManager::GetNotificationsForState	(	int64_t	startId,
		std::vector< ECamsNotificationState >	states,
		CamsGetNotificationsResult &	notifications
	)

Retrieve existing CAMS notifications with the state specified from the Server.

Notifications are retrieved in pages of size 30.

Parameters

startId	The notification ID at the start of the page to retrieve. Specifying an ID of -1 will retrieve the 30 most recent notifications available.
states	A list of the ECamsNotificationStates to filter for. CAMS_STATE_NONE will return notifications of all states.
notifications	CamsGetNotificationsResult object containing the relevant notification information.

Returns: OpResult OR_Success if the query is successful. Error result if not.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::CamsNotificationManager::UpdateCamsNotifications	(	const std::vector< int64_t > &	ids,
		const ECamsNotificationState	old_state,
		const ECamsNotificationState	new_state
	)

Change the state of the specified CAMS notifications.

The Server will issue notification updates via the IServerEventListener interface to all listeners when the state change has been affected.

Parameters

ids	The list of notification IDs to apply the state change to.
old_state	The current ECamsNotificationState of the notifications listed. If the old_state value does not match the current value of the notification state at the server then the state change request will be ignored.
new_state	The desired new ECamsNotificationState of the notifications listed.

Returns: OpResult OR_Success if the query is successful. Error result if not.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::CamsNotificationManager::BulkUpdateCamsNotifications	(	const int64_t &	start_id,
		const int64_t &	end_id,
		const ECamsNotificationState	old_state,
		const ECamsNotificationState	new_state
	)

Change the state of the CAMS notifications with IDs in the specified range.

The Server will issue notification updates via the IServerEventListener interface to all listeners when the state change has been affected.

Parameters

start_id	The start of the range of notification IDs to apply the state change to.
end_id	The end of the range of notification IDs to apply the state change to.
old_state	The current ECamsNotificationState of the notifications listed. If the old_state value does not match the current value of the notification state at the server then the state change request will be ignored for that notification, only notifications in the range with a matching current state will be processed by this request.
new_state	The desired new ECamsNotificationState of the notifications listed.

Returns: OpResult OR_Success if the query is successful. Error result if not.

The documentation for this class was generated from the following file: