Take the community feedback survey now.

AI OnAI Off

Interface INotifier

Class for sending NotificationMessages

Namespace: EPiServer.Notification
Assembly: EPiServer.dll
Version: 12.0.3
Syntax
public interface INotifier

Methods

add_NotificationFiltered(AsyncEventHandler<NotificationEventArgs>)

Declaration
void add_NotificationFiltered(AsyncEventHandler<NotificationEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<NotificationEventArgs> value

add_NotificationPosted(AsyncEventHandler<NotificationEventArgs>)

Declaration
void add_NotificationPosted(AsyncEventHandler<NotificationEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<NotificationEventArgs> value

add_NotificationSaved(AsyncEventHandler<NotificationEventArgs>)

Declaration
void add_NotificationSaved(AsyncEventHandler<NotificationEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<NotificationEventArgs> value

PostNotificationAsync(NotificationMessage)

Posts a message for delivery. The delivery of the message depends on user settings, which INotificationFormatter and INotificationProvider that are registered.

Declaration
Task PostNotificationAsync(NotificationMessage notification)
Parameters
Type Name Description
NotificationMessage notification

The message to send.
Returns
Type Description
System.Threading.Tasks.Task
Remarks

INotificationChannelOptionsRegistry can be used to configure if an message should be processed immediately or scheduled. By default are messages processed scheduled.

When PostNotificationAsync(NotificationMessage) is completed the messages is stored for send processing. However even if Immediate is configured for channel the actual send process is done in background, in case of Immediate the processing is triggered without waiting for next scheduling.

remove_NotificationFiltered(AsyncEventHandler<NotificationEventArgs>)

Declaration
void remove_NotificationFiltered(AsyncEventHandler<NotificationEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<NotificationEventArgs> value

remove_NotificationPosted(AsyncEventHandler<NotificationEventArgs>)

Declaration
void remove_NotificationPosted(AsyncEventHandler<NotificationEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<NotificationEventArgs> value

remove_NotificationSaved(AsyncEventHandler<NotificationEventArgs>)

Declaration
void remove_NotificationSaved(AsyncEventHandler<NotificationEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<NotificationEventArgs> value

Events

NotificationFiltered

Occurs when a message is filtered.

Declaration
event AsyncEventHandler<NotificationEventArgs> NotificationFiltered
Event Type
Type Description
AsyncEventHandler<NotificationEventArgs>

NotificationPosted

Occurs when a message is notified.

Declaration
event AsyncEventHandler<NotificationEventArgs> NotificationPosted
Event Type
Type Description
AsyncEventHandler<NotificationEventArgs>

NotificationSaved

Occurs when a message is saved.

Declaration
event AsyncEventHandler<NotificationEventArgs> NotificationSaved
Event Type
Type Description
AsyncEventHandler<NotificationEventArgs>

Extension Methods