Class EmailList

Namespace

Kentico.Xperience.Admin.DigitalMarketing.UIPages

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Emails listing page.

public sealed class EmailList : ListingPage, IPage

Inheritance

object

Page<ListingTemplateClientProperties>

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>

ListingPage<ListingTemplateClientProperties>

ListingPage

EmailList

Implements

IPage

Inherited Members

ListingPage<ListingTemplateClientProperties>.PageConfiguration

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>.PageConfiguration

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>.LoadData(LoadDataCommandArguments, CancellationToken)

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>.ComponentCommand(FormComponentCommandModel, CancellationToken)

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>.ConfigureTemplateProperties(ListingTemplateClientProperties)

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>.Change(FormSubmissionCommandArguments, CancellationToken)

Page<ListingTemplateClientProperties>.ValidatePage()

Page<ListingTemplateClientProperties>.ConfigureTemplateProperties(ListingTemplateClientProperties)

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

EmailList(IInfoProvider<EmailConfigurationInfo>, IPageLinkGenerator, IEmailListFormatterService, IAuthenticatedUserAccessor, IEmailConfigurationManagerFactory, IChannelItemCounter, IContentItemCommonDataInfoRetriever, IContentItemReferenceManagerCore, IServiceProvider)

Initializes an instance of the EmailList class.

public EmailList(IInfoProvider<EmailConfigurationInfo> emailConfigurationInfoProvider, IPageLinkGenerator pageLinkGenerator, IEmailListFormatterService emailListFormatterService, IAuthenticatedUserAccessor authenticatedUserAccessor, IEmailConfigurationManagerFactory emailConfigurationManagerFactory, IChannelItemCounter channelItemCounter, IContentItemCommonDataInfoRetriever contentItemCommonDataInfoRetriever, IContentItemReferenceManagerCore contentItemReferenceManagerCore, IServiceProvider serviceProvider)

Parameters

emailConfigurationInfoProvider IInfoProvider<EmailConfigurationInfo>

pageLinkGenerator IPageLinkGenerator

emailListFormatterService IEmailListFormatterService

authenticatedUserAccessor IAuthenticatedUserAccessor

emailConfigurationManagerFactory IEmailConfigurationManagerFactory

channelItemCounter IChannelItemCounter

contentItemCommonDataInfoRetriever IContentItemCommonDataInfoRetriever

contentItemReferenceManagerCore IContentItemReferenceManagerCore

serviceProvider IServiceProvider

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

ObjectType

Type of the info objects that are listed. Corresponds to the OBJECT_TYPE property of the info object or PredefinedObjectType.

protected override string ObjectType { get; }

Property Value

string

RefetchAllOnDelete

Indicates whether to refetch all templates on delete.

protected override bool RefetchAllOnDelete { get; }

Property Value

bool

Methods

Clone(int, CancellationToken)

Creates a clone from the selected email.

public Task<ICommandResponse> Clone(int id, CancellationToken cancellationToken)

Parameters

id int

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

ConfigurePage()

Allows configure and share page specific values prior invocation of the ConfigureTemplateProperties(TClientProperties) or command method.

public override Task ConfigurePage()

Returns

Task

Create(CancellationToken)

Redirects to email creation page.

public Task<ICommandResponse> Create(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation instructions.

Returns

Task<ICommandResponse>

Delete(int)

Deletes email specified by the id parameter.

public override Task<ICommandResponse<RowActionResult>> Delete(int id)

Parameters

id int

Returns

Task<ICommandResponse<RowActionResult>>

Exceptions

InvalidOperationException

Email with id does not exists.

GetFilterFormComponentsContext()

Gets the form component context for the form components.

protected override Task<IFormContext> GetFilterFormComponentsContext()

Returns

Task<IFormContext>

RedirectToEmailDetail(int, CancellationToken)

Redirects to email detail.

public Task<ICommandResponse> RedirectToEmailDetail(int id, CancellationToken cancellationToken)

Parameters

id int

ID of the email.

cancellationToken CancellationToken

Cancellation instructions.

Returns

Task<ICommandResponse>