sharedlibrarycoreinterfaces IAlertManager - RaidMax/IW4M-Admin GitHub Wiki
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Interfaces
SharedLibraryCore.Interfaces.IAlertManager[[IAlertManager]]
class SharedLibraryCore.Interfaces.IAlertManager interfaceStyle;
end
| Type | Name | Methods |
|---|---|---|
EventHandler<AlertState> |
OnAlertConsumedFires when an alert has been consumed (dimissed) |
get, set |
| Returns | Name |
|---|---|
void |
AddAlert(AlertState alert) |
Task |
Initialize()Initializes the manager |
void |
MarkAlertAsRead(Guid alertId)Marks an alert as read and removes it from the manager |
void |
MarkAllAlertsAsRead(int recipientId)Mark all alerts intended for the given recipientId as read |
void |
RegisterStaticAlertSource(Func<Task<IEnumerable<AlertState>>> alertSource) |
IEnumerable<AlertState> |
RetrieveAlerts(EFClient client)Get all the alerts for given client |
public Task Initialize()Initializes the manager
public IEnumerable<AlertState> RetrieveAlerts(EFClient client)| Type | Name | Description |
|---|---|---|
EFClient |
client | client to retrieve alerts for |
Get all the alerts for given client
public void AddAlert(AlertState alert)| Type | Name | Description |
|---|---|---|
AlertState |
alert |
public void MarkAlertAsRead(Guid alertId)| Type | Name | Description |
|---|---|---|
Guid |
alertId | Id of the alert to mark as read |
Marks an alert as read and removes it from the manager
public void MarkAllAlertsAsRead(int recipientId)| Type | Name | Description |
|---|---|---|
int |
recipientId | Identifier of the recipient |
Mark all alerts intended for the given recipientId as read
public void RegisterStaticAlertSource(Func<Task<IEnumerable<AlertState>>> alertSource)| Type | Name | Description |
|---|---|---|
Func<Task<IEnumerable<AlertState>>> |
alertSource |
public EventHandler<AlertState> OnAlertConsumed { get; set; }Fires when an alert has been consumed (dimissed)
Generated with ModularDoc
