The NotificationLogger stores Notifications and provides an interface to retrieve them. More...

#include <INotificationLoggerService2.hpp>

Inheritance diagram for Arp::Services::NotificationLogger::Services::INotificationLoggerService2:

Public Types
using	Ptr = std::shared_ptr< INotificationLoggerService2 >

using	ReadStoredNotificationsResultDelegate = delegate< void(IRscReadEnumerator< StoredNotification2 > &)>

Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

Public Member Functions
	INotificationLoggerService2 (void)=default
	Constructs an INotificationLoggerService2 instance.

virtual void	ReadStoredNotifications (const std::vector< RscString< 64 > > &archives, const NotificationFilter2 &filter, int32 limit, SortOrder sortOrder, boolean includePayloadXml, ReadStoredNotificationsResultDelegate resultDelegate)=0
	Queries notifications matching the supplied filter from the mentioned archives and returns them as StoredNotification2 objects More...

virtual int32	DeleteNotifications (const std::vector< RscString< 64 > > &archives, const NotificationFilter2 &filter)=0
	Remove notifications mathing the filter from the given archives More...

virtual std::vector< RscString< 64 > >	GetArchiveNames ()=0
	Queries a list of archives More...

Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
	IRscService (void)=default
	The default constructor.

	IRscService (const IRscService &arg)=delete
	The deleted copy constructor. More...

	IRscService (IRscService &&arg) noexcept=default
	The default move constructor. More...

IRscService &	operator= (const IRscService &arg)=delete
	The deleted assignment operator. More...

IRscService &	operator= (IRscService &&arg) noexcept=default
	The default move-assignment operator. More...

virtual	~IRscService (void)=default
	Destructs this instance and frees all resources.

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)

Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of this service. More...

Detailed Description

The NotificationLogger stores Notifications and provides an interface to retrieve them.

This service is defined in library Arp.Services.NotificationLogger.

Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.

Consider the following common rule when using RSC services that provide arrays or enumerators as return values or out arguments: It is always required to completely read all items from these resulting lists or enumerators.

Member Function Documentation

◆ DeleteNotifications()

virtual int32 Arp::Services::NotificationLogger::Services::INotificationLoggerService2::DeleteNotifications	(	const std::vector< RscString< 64 > > &	archives,
		const NotificationFilter2 &	filter
	)

pure virtual

Remove notifications mathing the filter from the given archives

Parameters

archives	List of archives to delete notifications from. Empty list deletes from all.
filter	Filter specification, matching notifications are removed

Returns: Number of deleted notifications

◆ GetArchiveNames()

virtual std::vector< RscString< 64 > > Arp::Services::NotificationLogger::Services::INotificationLoggerService2::GetArchiveNames ( )

pure virtual

Queries a list of archives

Returns: List of known archives

Corresponds to ListArchives of Arp.Services.NotificationLogger.Services.INotificationLoggerService

◆ ReadStoredNotifications()

virtual void Arp::Services::NotificationLogger::Services::INotificationLoggerService2::ReadStoredNotifications	(	const std::vector< RscString< 64 > > &	archives,
		const NotificationFilter2 &	filter,
		int32	limit,
		SortOrder	sortOrder,
		boolean	includePayloadXml,
		ReadStoredNotificationsResultDelegate	resultDelegate
	)

pure virtual

Queries notifications matching the supplied filter from the mentioned archives and returns them as StoredNotification2 objects

Parameters

archives	List of archives to query. Empty list queries all.
filter	Filter specifications
limit	Maximum number of returned notifications
sortOrder	Sorting to apply
includePayloadXml	If `true`, payload as XML is included in result

Returns: Collection of notifications

Corresponds to QueryStoredNotifications of Arp.Services.NotificationLogger.Services.INotificationLoggerService

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

Arp/Services/NotificationLogger/Services/INotificationLoggerService2.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ DeleteNotifications()

◆ GetArchiveNames()

◆ ReadStoredNotifications()