sharedlibrarycoreinterfaces IAlertManager

IAlertManager Public interface

Diagram

  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

Loading

Members

Properties

Public properties

Type	Name	Methods
EventHandler<AlertState>	OnAlertConsumed Fires when an alert has been consumed (dimissed)	get, set

Methods

Public methods

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

Details

Methods

Initialize

Source code

public Task Initialize()

Summary

Initializes the manager

Returns

RetrieveAlerts

Source code

public IEnumerable<AlertState> RetrieveAlerts(EFClient client)

Arguments

Type	Name	Description
EFClient	client	client to retrieve alerts for

Summary

Get all the alerts for given client

Returns

AddAlert

Source code

public void AddAlert(AlertState alert)

Arguments

Type	Name	Description
AlertState	alert

MarkAlertAsRead

Source code

public void MarkAlertAsRead(Guid alertId)

Arguments

Type	Name	Description
Guid	alertId	Id of the alert to mark as read

Summary

Marks an alert as read and removes it from the manager

MarkAllAlertsAsRead

Source code

public void MarkAllAlertsAsRead(int recipientId)

Arguments

Type	Name	Description
int	recipientId	Identifier of the recipient

Summary

Mark all alerts intended for the given recipientId as read

RegisterStaticAlertSource

Source code

public void RegisterStaticAlertSource(Func<Task<IEnumerable<AlertState>>> alertSource)

Arguments

Type	Name	Description
Func<Task<IEnumerable<AlertState>>>	alertSource

Properties

OnAlertConsumed

public EventHandler<AlertState> OnAlertConsumed { get; set; }

Summary

Fires when an alert has been consumed (dimissed)

Generated with ModularDoc