Class EmailChannelSenderEdit

Namespace

Kentico.Xperience.Admin.DigitalMarketing.UIPages

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Email channel sender edit dialog.

[UIPageLocation(PageLocationEnum.Dialog)]
[UINavigation(false)]
[UIBreadcrumbs(false)]
public sealed class EmailChannelSenderEdit : InfoEditPage<EmailChannelSenderInfo>, IPage

Inheritance

object

Page<EditTemplateClientProperties>

EditPageBase

InfoEditPageBase<EmailChannelSenderInfo>

InfoEditPage<EmailChannelSenderInfo>

EmailChannelSenderEdit

Implements

IPage

Inherited Members

InfoEditPageBase<EmailChannelSenderInfo>.ConfigureTemplateProperties(EditTemplateClientProperties)

InfoEditPageBase<EmailChannelSenderInfo>.RegisterMacroField(MacroField)

EditPageBase.PageConfiguration

EditPageBase.ComponentCommand(FormComponentCommandModel, CancellationToken)

EditPageBase.Change(FormChangeCommandArguments)

EditPageBase.Submit(FormSubmissionCommandArguments)

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

EmailChannelSenderEdit(IFormComponentMapper, IFormDataBinder, IEmailChannelSenderEmailProvider, IEmailBounceCheckerOptionsRetriever)

Initializes a new instance of the EmailChannelSenderEdit class.

public EmailChannelSenderEdit(IFormComponentMapper formComponentMapper, IFormDataBinder formDataBinder, IEmailChannelSenderEmailProvider emailChannelSenderEmailProvider, IEmailBounceCheckerOptionsRetriever emailBounceCheckerOptionsRetriever)

Parameters

formComponentMapper IFormComponentMapper

formDataBinder IFormDataBinder

emailChannelSenderEmailProvider IEmailChannelSenderEmailProvider

emailBounceCheckerOptionsRetriever IEmailBounceCheckerOptionsRetriever

Properties

EmailChannelID

Email channel ID.

[PageParameter(typeof(EmailChannelModelBinder), typeof(ChannelEditSection))]
public int EmailChannelID { get; set; }

Property Value

int

ObjectId

Email channel sender ID.

[PageParameter(typeof(IntPageModelBinder))]
public override int ObjectId { get; set; }

Property Value

int

Methods

ConfigurePage()

Set up page's configuration. Configures the submit action.

public override Task ConfigurePage()

Returns

Task

FinalizeInfoObject(EmailChannelSenderInfo, IFormFieldValueProvider, CancellationToken)

Allows to modify values of infoObject before validation and saving.

protected override Task FinalizeInfoObject(EmailChannelSenderInfo infoObject, IFormFieldValueProvider fieldValueProvider, CancellationToken cancellationToken)

Parameters

infoObject EmailChannelSenderInfo

Info object to be set.

fieldValueProvider IFormFieldValueProvider

Provider of form field values.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task

GetFormItems()

Prepares form items for editing object of the specified ObjectType.

protected override Task<ICollection<IFormItem>> GetFormItems()

Returns

Task<ICollection<IFormItem>>

Returns the collection of form items.

SubmitInternal(FormSubmissionCommandArguments, ICollection<IFormItem>, IFormFieldValueProvider)

Handles the internal specific processing of form submit command.

protected override Task<ICommandResponse> SubmitInternal(FormSubmissionCommandArguments args, ICollection<IFormItem> items, IFormFieldValueProvider formFieldValueProvider)

Parameters

args FormSubmissionCommandArguments

Form submission arguments.

items ICollection<IFormItem>

Form items with bound component values.

formFieldValueProvider IFormFieldValueProvider

Provider of form field values.

Returns

Task<ICommandResponse>

Returns the form submission result.

Remarks

This method is called by the default implementation of the Submit(FormSubmissionCommandArguments) method.

See Also

Submit(FormSubmissionCommandArguments)

ValidatePage()

Validates the page state prior invocation of the ConfigurePage() method.

public override Task<PageValidationResult> ValidatePage()

Returns

Task<PageValidationResult>