Table of Contents

Class EmailChannelSenderCreate

Namespace
Kentico.Xperience.Admin.DigitalMarketing.UIPages
Assembly
Kentico.Xperience.Admin.DigitalMarketing.dll

Email channel sender creat dialog.

[UIPageLocation(PageLocationEnum.Dialog)]
[UINavigation(false)]
[UIBreadcrumbs(false)]
public sealed class EmailChannelSenderCreate : CreatePage<EmailChannelSenderInfo, EmailChannelSendersList>, IPage
Inheritance
object
EmailChannelSenderCreate
Implements
Inherited Members
Extension Methods

Constructors

EmailChannelSenderCreate(IFormComponentMapper, IFormDataBinder, IPageLinkGenerator, IEmailChannelSenderEmailProvider, IEmailBounceCheckerOptionsRetriever)

Initializes an instance of the EmailChannelSenderCreate class.

public EmailChannelSenderCreate(IFormComponentMapper formComponentMapper, IFormDataBinder formDataBinder, IPageLinkGenerator pageLinkGenerator, IEmailChannelSenderEmailProvider emailChannelSenderEmailProvider, IEmailBounceCheckerOptionsRetriever emailBounceCheckerOptionsRetriever)

Parameters

formComponentMapper IFormComponentMapper
formDataBinder IFormDataBinder
pageLinkGenerator IPageLinkGenerator
emailChannelSenderEmailProvider IEmailChannelSenderEmailProvider
emailBounceCheckerOptionsRetriever IEmailBounceCheckerOptionsRetriever

Properties

ChannelID

Channel ID.

[PageParameter(typeof(IntPageModelBinder), typeof(ChannelEditSection))]
public int ChannelID { get; set; }

Property Value

int

EmailChannelID

Email channel ID.

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

Property Value

int

Methods

ConfigurePage()

Set up page's configuration. Configures UI page.

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.

GetSubmitSuccessResponse(EmailChannelSenderInfo, ICollection<IFormItem>)

Response that has to be returned after successful form submission.

protected override Task<ICommandResponse> GetSubmitSuccessResponse(EmailChannelSenderInfo savedInfoObject, ICollection<IFormItem> items)

Parameters

savedInfoObject EmailChannelSenderInfo

Object info after persisting.

items ICollection<IFormItem>

Collection with updated form items.

Returns

Task<ICommandResponse>

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

ValidatePage()

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

public override Task<PageValidationResult> ValidatePage()

Returns

Task<PageValidationResult>