Interface INotificationFormatter
NOTE: This is a pre-release API that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version. Signature for components that formats NotificationMessage.
Namespace: EPiServer.Notification
Assembly: EPiServer.dll
Version: 9.12.2Syntax
public interface INotificationFormatterProperties
FormatterName
The name of the formatter.
Declaration
string FormatterName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
SupportedChannelNames
Specifies which channels the formatter supports.
Declaration
IEnumerable<string> SupportedChannelNames { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> |
Methods
FormatMessages(IEnumerable<FormatterNotificationMessage>, String, NotificationFormat, String)
Performs formatting of messages.
Declaration
IEnumerable<FormatterNotificationMessage> FormatMessages(IEnumerable<FormatterNotificationMessage> notifications, string recipient, NotificationFormat format, string channelName)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<FormatterNotificationMessage> | notifications | Messages to format |
| System.String | recipient | The receiver of the message |
| NotificationFormat | format | The format to format to |
| System.String | channelName | The message channel |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<FormatterNotificationMessage> | A list of formatted messages |
Remarks
One use case for a formatter might be to combine several messages into one.
