Interface IUserNotificationFormatter
Used for formatting UserNotificationMessage.
Namespace: EPiServer.Notification
Assembly: EPiServer.dll
Version: 10.10.4Syntax
public interface IUserNotificationFormatter
Remarks
When using the GetUserNotification(s)-methods in the interface IUserNotificationRepository, formatting will be done depending on the UserNotificationFormattingMode. If the message shall be formatted, it is automatically resolved which formatter that should be used.
Properties
SupportedChannelNames
Specifies which channels the formatter supports.
Declaration
IEnumerable<string> SupportedChannelNames { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> |
Methods
FormatUserMessageAsync(UserNotificationMessage)
Performs formatting of messages.
Declaration
Task<UserNotificationMessage> FormatUserMessageAsync(UserNotificationMessage notification)
Parameters
| Type | Name | Description |
|---|---|---|
| UserNotificationMessage | notification | Message to format |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<UserNotificationMessage> | A formatted message |