The NotificationLogger stores Notifications and provides an interface to retrieve them.
More...
#include <INotificationLoggerService.hpp>
|
| INotificationLoggerService (void) |
| Constructs an INotificationLoggerService instance. More...
|
|
virtual | ~INotificationLoggerService (void) |
| Destructs this instance and frees all resouces. More...
|
|
virtual std::vector< StoredNotification > | QueryStoredNotifications (const std::vector< RscString< 512 >> &archives, const NotificationFilter &filter, int32 limit, SortOrder sortOrder, const RscString< 512 > &language)=0 |
| Queries notifications matching the supplied filter from the mentioned archives and returns them as StoredNotification objects More...
|
|
virtual std::vector< Notification > | QueryNotifications (const std::vector< RscString< 512 >> &archives, const NotificationFilter &filter, int32 limit, SortOrder sortOrder, const RscString< 512 > &language)=0 |
| Queries notifications matching the supplied filter from the mentioned archives and returns them as Notification objects More...
|
|
virtual int32 | DeleteNotifications (const std::vector< RscString< 512 >> &archives, const NotificationFilter &filter)=0 |
| Remove notifications mathing the filter from the given archives More...
|
|
virtual std::vector< RscString< 512 > > | ListArchives ()=0 |
| Queries a list of archives More...
|
|
virtual std::vector< RscString< 512 > > | GetArchiveConfiguration (const RscString< 512 > &archive)=0 |
| Query the configuration as XML for the given archive More...
|
|
virtual boolean | SetArchiveConfiguration (const RscString< 512 > &archive, const std::vector< RscString< 512 >> &xmlConfiguration)=0 |
| Set the configuration of the given archive More...
|
|
virtual boolean | ResetArchiveConfigurationToFiles (const RscString< 512 > &archive)=0 |
| Resets the configuration of the given archive to the configuration files. All changes made by RSC are reverted. More...
|
|
| IRscService (void)=default |
| Constructs an IRscService instance. More...
|
|
virtual | ~IRscService (void)=default |
| Destructs this instance and frees all resouces. More...
|
|
|
static IRscServiceProxyFactory & | GetProxyFactory (void) |
|
static IRscServiceProxyFactory & | GetProxyFactory (void) |
| Returns a reference to service proxy factory to create a proxy instance of the service More...
|
|
The NotificationLogger stores Notifications and provides an interface to retrieve them.
◆ INotificationLoggerService()
Arp::Services::NotificationLogger::Services::INotificationLoggerService::INotificationLoggerService |
( |
void |
| ) |
|
|
inline |
◆ ~INotificationLoggerService()
Arp::Services::NotificationLogger::Services::INotificationLoggerService::~INotificationLoggerService |
( |
void |
| ) |
|
|
inlinevirtual |
Destructs this instance and frees all resouces.
◆ DeleteNotifications()
virtual int32 Arp::Services::NotificationLogger::Services::INotificationLoggerService::DeleteNotifications |
( |
const std::vector< RscString< 512 >> & |
archives, |
|
|
const NotificationFilter & |
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
◆ GetArchiveConfiguration()
virtual std::vector<RscString<512> > Arp::Services::NotificationLogger::Services::INotificationLoggerService::GetArchiveConfiguration |
( |
const RscString< 512 > & |
archive | ) |
|
|
pure virtual |
Query the configuration as XML for the given archive
- Parameters
-
archive | name of the archive |
- Returns
- XML of the configuration
◆ ListArchives()
virtual std::vector<RscString<512> > Arp::Services::NotificationLogger::Services::INotificationLoggerService::ListArchives |
( |
| ) |
|
|
pure virtual |
Queries a list of archives
- Returns
- list of known archives
◆ QueryNotifications()
virtual std::vector<Notification> Arp::Services::NotificationLogger::Services::INotificationLoggerService::QueryNotifications |
( |
const std::vector< RscString< 512 >> & |
archives, |
|
|
const NotificationFilter & |
filter, |
|
|
int32 |
limit, |
|
|
SortOrder |
sortOrder, |
|
|
const RscString< 512 > & |
language |
|
) |
| |
|
pure virtual |
Queries notifications matching the supplied filter from the mentioned archives and returns them as Notification 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 |
language | translate notification payloads |
- Returns
- collection of notifications
◆ QueryStoredNotifications()
Queries notifications matching the supplied filter from the mentioned archives and returns them as StoredNotification 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 |
language | translate notification payloads |
- Returns
- collection of notifications
◆ ResetArchiveConfigurationToFiles()
virtual boolean Arp::Services::NotificationLogger::Services::INotificationLoggerService::ResetArchiveConfigurationToFiles |
( |
const RscString< 512 > & |
archive | ) |
|
|
pure virtual |
Resets the configuration of the given archive to the configuration files. All changes made by RSC are reverted.
- Parameters
-
archive | name of the archive |
- Returns
- true on success
◆ SetArchiveConfiguration()
virtual boolean Arp::Services::NotificationLogger::Services::INotificationLoggerService::SetArchiveConfiguration |
( |
const RscString< 512 > & |
archive, |
|
|
const std::vector< RscString< 512 >> & |
xmlConfiguration |
|
) |
| |
|
pure virtual |
Set the configuration of the given archive
- Parameters
-
archive | name of the archive |
xmlConfiguration | XML containing the configuration |
- Returns
- true on success
The documentation for this class was generated from the following file: