Class EmailContentTab

Namespace

Kentico.Xperience.Admin.DigitalMarketing.UIPages

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Page for editing email configuration content.

public sealed class EmailContentTab : Page<EmailContentTabClientProperties>, IPage

Inheritance

object

Page<EmailContentTabClientProperties>

EmailContentTab

Implements

IPage

Inherited Members

Page<EmailContentTabClientProperties>.ConfigurePage()

Page<EmailContentTabClientProperties>.ValidatePage()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

EmailContentTab(IAuthenticatedUserAccessor, IFormComponentCommandInvoker, IUIPermissionEvaluator, IEmailDetailedStatusRetriever, IEmailConfigurationNameService, IEmailConfigurationAdminModelRetriever, IContentLanguageRetriever, IEmailHtmlContentConverter, IContentItemUIDataRetriever, IEmailConfigurationWorkflowStepRoleArbiter)

Initializes a new instance of EmailContentTab.

public EmailContentTab(IAuthenticatedUserAccessor authenticatedUserAccessor, IFormComponentCommandInvoker formComponentCommandInvoker, IUIPermissionEvaluator permissionEvaluator, IEmailDetailedStatusRetriever emailDetailedStatusRetriever, IEmailConfigurationNameService emailConfigurationNameService, IEmailConfigurationAdminModelRetriever emailConfigurationAdminModelRetriever, IContentLanguageRetriever contentLanguageRetriever, IEmailHtmlContentConverter emailContentConverter, IContentItemUIDataRetriever contentItemUIDataRetriever, IEmailConfigurationWorkflowStepRoleArbiter workflowStepRoleArbiter)

Parameters

authenticatedUserAccessor IAuthenticatedUserAccessor

formComponentCommandInvoker IFormComponentCommandInvoker

permissionEvaluator IUIPermissionEvaluator

emailDetailedStatusRetriever IEmailDetailedStatusRetriever

emailConfigurationNameService IEmailConfigurationNameService

emailConfigurationAdminModelRetriever IEmailConfigurationAdminModelRetriever

contentLanguageRetriever IContentLanguageRetriever

emailContentConverter IEmailHtmlContentConverter

contentItemUIDataRetriever IContentItemUIDataRetriever

workflowStepRoleArbiter IEmailConfigurationWorkflowStepRoleArbiter

Properties

ChannelApplicationIdentifier

Application identifier.

[PageParameter(typeof(EmailChannelsApplicationModelBinder), typeof(EmailChannelApplication))]
public EmailChannelApplicationUrlIdentifier ChannelApplicationIdentifier { get; set; }

Property Value

EmailChannelApplicationUrlIdentifier

ContentLanguageIdentifier

Content language identifier.

[PageParameter(typeof(ContentLanguageModelBinder), typeof(EmailChannelContentLanguage))]
public ContentLanguageUrlIdentifier ContentLanguageIdentifier { get; set; }

Property Value

ContentLanguageUrlIdentifier

EmailConfigurationID

Email configuration identifier.

[PageParameter(typeof(IntPageModelBinder), typeof(EmailEditLayout))]
public int EmailConfigurationID { get; set; }

Property Value

int

Methods

CascadePublish(EmailConfigurationCommandArguments, CancellationToken)

Updates the current email and redirects to the cascade publish page.

[PageCommand(CommandName = "CascadePublish", Permission = "Update")]
public Task<ICommandResponse> CascadePublish(EmailConfigurationCommandArguments args, CancellationToken cancellationToken)

Parameters

args EmailConfigurationCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

Change(FormSubmissionCommandArguments, CancellationToken)

Update form on change.

[PageCommand(CommandName = "Change", Permission = "Update")]
public Task<ICommandResponse> Change(FormSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormSubmissionCommandArguments

Submission arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Returns the updated form components.

ChangeWorkflowStep(EmailConfigurationCommandArguments, CancellationToken)

Updates the current email and redirects to the change workflow step page.

[PageCommand(CommandName = "ChangeWorkflowStep", Permission = "Update")]
public Task<ICommandResponse> ChangeWorkflowStep(EmailConfigurationCommandArguments args, CancellationToken cancellationToken)

Parameters

args EmailConfigurationCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

Clone(EmailConfigurationCommandArguments, CancellationToken)

Command handling click on Clone button.

[PageCommand(CommandName = "Clone", Permission = "Create")]
public Task<ICommandResponse> Clone(EmailConfigurationCommandArguments args, CancellationToken cancellationToken)

Parameters

args EmailConfigurationCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

ComponentCommand(FormComponentCommandModel, CancellationToken)

Handles the form component command invocation.

[PageCommand]
public Task<object> ComponentCommand(FormComponentCommandModel commandModel, CancellationToken cancellationToken)

Parameters

commandModel FormComponentCommandModel

Form component command arguments.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<object>

Returns the form component command result.

ConfigureTemplateProperties(EmailContentTabClientProperties)

Gets the object representing client side template properties.

public override Task<EmailContentTabClientProperties> ConfigureTemplateProperties(EmailContentTabClientProperties properties)

Parameters

properties EmailContentTabClientProperties

Initialized properties object.

Returns

Task<EmailContentTabClientProperties>

Continue(EmailConfigurationCommandArguments, CancellationToken)

Command handling click on Continue button.

[PageCommand(CommandName = "Continue", Permission = "Update")]
public Task<ICommandResponse> Continue(EmailConfigurationCommandArguments args, CancellationToken cancellationToken)

Parameters

args EmailConfigurationCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

Delete(CancellationToken)

Command handling click on Delete button.

[PageCommand(CommandName = "Delete", Permission = "Delete")]
public Task<ICommandResponse> Delete(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

DiscardChanges(CancellationToken)

Command handling click on Discard button.

[PageCommand(CommandName = "DiscardChanges", Permission = "Update")]
public Task<ICommandResponse> DiscardChanges(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

Edit(CancellationToken)

Command handling click on Edit button for emails that are not regular.

[PageCommand(CommandName = "Edit", Permission = "Update")]
public Task<ICommandResponse> Edit(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

EditRegular(CancellationToken)

Command handling click on Edit button for regular emails.

[PageCommand(CommandName = "EditRegular", Permission = "SendEmail")]
public Task<ICommandResponse> EditRegular(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

GetStatusModel()

Endpoint that returns DetailedStatusModel.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<DetailedStatusModel>> GetStatusModel()

Returns

Task<ICommandResponse<DetailedStatusModel>>

Publish(EmailConfigurationCommandArguments, CancellationToken)

Updates and publishes the current email.

[PageCommand(CommandName = "Publish", Permission = "Update")]
public Task<ICommandResponse> Publish(EmailConfigurationCommandArguments args, CancellationToken cancellationToken)

Parameters

args EmailConfigurationCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

Rename(RenameCommandArguments, CancellationToken)

Updates email configuration display name.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse> Rename(RenameCommandArguments args, CancellationToken cancellationToken)

Parameters

args RenameCommandArguments

Rename command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse>

Reschedule(CancellationToken)

Command handling click on Reschedule button.

[PageCommand(CommandName = "Reschedule", Permission = "SendEmail")]
public Task<ICommandResponse> Reschedule(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

ReviewAndSend(EmailConfigurationCommandArguments, CancellationToken)

Updates the current email and redirects to the review and send page.

[PageCommand(CommandName = "ReviewAndSend", Permission = "SendEmail")]
public Task<ICommandResponse> ReviewAndSend(EmailConfigurationCommandArguments args, CancellationToken cancellationToken)

Parameters

args EmailConfigurationCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

Save(FormSubmissionCommandArguments, CancellationToken)

Saves page data changes.

[PageCommand(CommandName = "Save", Permission = "Update")]
public Task<ICommandResponse> Save(FormSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormSubmissionCommandArguments

Submission arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

SendDraft(EmailConfigurationCommandArguments, CancellationToken)

Command handling click on Send draft button.

[PageCommand(CommandName = "SendDraft", Permission = "Update")]
public Task<ICommandResponse> SendDraft(EmailConfigurationCommandArguments args, CancellationToken cancellationToken)

Parameters

args EmailConfigurationCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>