Table of Contents

Class NotificationEmailPlaceholderConfigurationStore

Namespace
CMS.Notifications
Assembly
CMS.Notifications.dll

Provides methods to store and retrieve notification email placeholder configurations.

public sealed class NotificationEmailPlaceholderConfigurationStore
Inheritance
object
NotificationEmailPlaceholderConfigurationStore
Extension Methods

Properties

Instance

Register instance.

public static NotificationEmailPlaceholderConfigurationStore Instance { get; }

Property Value

NotificationEmailPlaceholderConfigurationStore

Methods

TryAdd(INotificationEmailPlaceholdersByCodeName)

Attempts to add the placeholders configuration to the configuration store.

public bool TryAdd(INotificationEmailPlaceholdersByCodeName notificationPlaceholders)

Parameters

notificationPlaceholders INotificationEmailPlaceholdersByCodeName

Placeholder configuration.

Returns

bool

True if the placeholders configuration was added successfully, otherwise false.

Remarks

If placeholders are defined both for event type and code name for a specific email, only the placeholders for code name are used.

Exceptions

ArgumentNullException

Throws when notificationPlaceholders is null.

TryAdd(INotificationEmailPlaceholdersByEventType)

Attempts to add the placeholders configuration to the configuration store.

public bool TryAdd(INotificationEmailPlaceholdersByEventType notificationPlaceholders)

Parameters

notificationPlaceholders INotificationEmailPlaceholdersByEventType

Placeholder configuration.

Returns

bool

True if the placeholders configuration was added successfully, otherwise false.

Remarks

If placeholders are defined both for event type and code name for a specific email, only the placeholders for code name are used.

Exceptions

ArgumentNullException

Throws when notificationPlaceholders is null.