SaaS CMS has officially launched! Learn more now.

Interface INotificationProvider

Signature for a component that can send NotificationMessage.

Namespace: EPiServer.Notification
Assembly: EPiServer.dll
Version: 11.20.7
Syntax
public interface INotificationProvider

Properties

ProviderName

Gets the name of the provider.

Declaration
string ProviderName { get; }
Property Value
Type Description
System.String

Methods

GetProviderFormat()

Specifie the format the provider supports.

Declaration
NotificationFormat GetProviderFormat()
Returns
Type Description
NotificationFormat

Supported format.

SendAsync(IEnumerable<ProviderNotificationMessage>, Action<ProviderNotificationMessage>, Action<ProviderNotificationMessage, Exception>)

Sends the formatted messages.

Declaration
Task SendAsync(IEnumerable<ProviderNotificationMessage> messages, Action<ProviderNotificationMessage> succeededAction, Action<ProviderNotificationMessage, Exception> failedAction)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ProviderNotificationMessage> messages

The messages to send.

System.Action<ProviderNotificationMessage> succeededAction

A success action that should be called for successfully sent messages.

System.Action<ProviderNotificationMessage, System.Exception> failedAction

A failure action that should be called when a message send operation fails.

Returns
Type Description
System.Threading.Tasks.Task

Extension Methods