PLCnext API Documentation  22.6.0.43
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::Services::NotificationLogger::Services::INotificationLoggerService2 Class Referenceabstract

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

#include <INotificationLoggerService2.hpp>

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

Public Types

using Ptr = std::shared_ptr< INotificationLoggerService2 >
 
using ReadStoredNotificationsResultDelegate = delegate< void(IRscReadEnumerator< StoredNotification2 > &)>
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 INotificationLoggerService2 (void)=default
 Constructs an INotificationLoggerService2 instance. More...
 
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::System::Rsc::Services::IRscService
 IRscService (void)=default
 Constructs an IRscService instance. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resouces. More...
 

Static Public Member Functions

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

Detailed Description

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

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

Constructor & Destructor Documentation

◆ INotificationLoggerService2()

Arp::Services::NotificationLogger::Services::INotificationLoggerService2::INotificationLoggerService2 ( void  )
default

Constructs an INotificationLoggerService2 instance.

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
archivesList of archives to delete notifications from. Empty list deletes from all.
filterFilter 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
archivesList of archives to query. Empty list queries all.
filterFilter specifications
limitMaximum number of returned notifications
sortOrderSorting to apply
includePayloadXmlIf 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: