Class EmailSelectorComponent

Namespace

Kentico.Xperience.Admin.DigitalMarketing.Forms

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Represents email selector form component.

[ComponentAttribute(typeof(EmailSelectorComponentAttribute))]
public sealed class EmailSelectorComponent : FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem

Inheritance

object

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>

EmailSelectorComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.ClientComponentName

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.Properties

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.FormContext

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.Name

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.Guid

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.Required

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.HasDependencies

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.ValidationRules

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.VisibilityConditions

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.AdditionalActions

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.AddValidationRule(IValidationRule)

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.AddAdditionalAction(IAdditionalAction)

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.AddVisibilityCondition(IVisibilityCondition)

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.GetValue()

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.SetValue(IEnumerable<EmailRelatedItem>)

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.GetClientProperties()

FormComponent<EmailSelectorProperties, EmailSelectorClientProperties, IEnumerable<EmailRelatedItem>>.BindContext(IFormContext)

Extension Methods

FormItemExtensions.IsValid(IFormItem)

FormItemExtensions.IsVisible(IFormItem)

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

EmailSelectorComponent(ILocalizationService, IInfoProvider<EmailChannelInfo>, IEmailChannelLanguageRetriever)

Initializes a new instance of EmailSelectorComponent.

public EmailSelectorComponent(ILocalizationService localizationService, IInfoProvider<EmailChannelInfo> emailChannelInfoProvider, IEmailChannelLanguageRetriever emailChannelLanguageRetriever)

Parameters

localizationService ILocalizationService

emailChannelInfoProvider IInfoProvider<EmailChannelInfo>

emailChannelLanguageRetriever IEmailChannelLanguageRetriever

Fields

IDENTIFIER

Represents the EmailSelectorComponent identifier.

public const string IDENTIFIER = "Kentico.Administration.EmailSelector"

Field Value

string

Properties

ClientComponentName

Represents the client component name.

public override string ClientComponentName { get; }

Property Value

string

Methods

ConfigureClientProperties(EmailSelectorClientProperties)

Configures the form component client properties.

protected override Task ConfigureClientProperties(EmailSelectorClientProperties clientProperties)

Parameters

clientProperties EmailSelectorClientProperties

The current instance of the form component client properties.

Returns

Task

Remarks

Override this method in order to configure form component client properties.

ConfigureComponent()

Configures the form component. This method is called when all form component properties are set.

protected override void ConfigureComponent()

Remarks

Override this method to set component inner state, like additional component validation rules.

LoadEmailChannelOptions()

Returns email panel email channel options.

public Task<ICommandResponse<LoadEmailChannelOptionsResult>> LoadEmailChannelOptions()

Returns

Task<ICommandResponse<LoadEmailChannelOptionsResult>>

LoadEmailPanelItems(LoadEmailPanelItemsCommandArguments)

Returns email panel items for a given node.

public Task<ICommandResponse<LoadEmailPanelItemsResult>> LoadEmailPanelItems(LoadEmailPanelItemsCommandArguments args)

Parameters

args LoadEmailPanelItemsCommandArguments

Level parameters.

Returns

Task<ICommandResponse<LoadEmailPanelItemsResult>>

LoadSelectedEmails(LoadSelectedEmailsCommandArguments)

Returns selected emails for given email identifiers.

public Task<ICommandResponse<LoadSelectedEmailsResult>> LoadSelectedEmails(LoadSelectedEmailsCommandArguments args)

Parameters

args LoadSelectedEmailsCommandArguments

Identifiers model of selected emails.

Returns

Task<ICommandResponse<LoadSelectedEmailsResult>>