Class HeadlessList

Namespace

Kentico.Xperience.Admin.Headless.UIPages

Assembly

Kentico.Xperience.Admin.Headless.dll

Headless listing page.

public sealed class HeadlessList : ListingPage, IPage

Inheritance

object

Page<ListingTemplateClientProperties>

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>

ListingPage<ListingTemplateClientProperties>

ListingPage

HeadlessList

Implements

IPage

Inherited Members

ListingPage<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)

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>.PageConfiguration

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

HeadlessList(IHeadlessItemManagerFactory, IAuthenticatedUserAccessor, ILocalizationService, IInfoProvider<HeadlessItemInfo>, IHeadlessChannelPreviewUrlProvider, IPageLinkGenerator, IUIPermissionEvaluator)

Initializes an instance of the HeadlessList class.

public HeadlessList(IHeadlessItemManagerFactory headlessItemManagerFactory, IAuthenticatedUserAccessor authenticatedUserAccessor, ILocalizationService localizationService, IInfoProvider<HeadlessItemInfo> headlessItemInfoProvider, IHeadlessChannelPreviewUrlProvider previewUrlProvider, IPageLinkGenerator pageLinkGenerator, IUIPermissionEvaluator permissionEvaluator)

Parameters

headlessItemManagerFactory IHeadlessItemManagerFactory

authenticatedUserAccessor IAuthenticatedUserAccessor

localizationService ILocalizationService

headlessItemInfoProvider IInfoProvider<HeadlessItemInfo>

previewUrlProvider IHeadlessChannelPreviewUrlProvider

pageLinkGenerator IPageLinkGenerator

permissionEvaluator IUIPermissionEvaluator

Properties

ChannelApplicationIdentifier

Application identifier.

[PageParameter(typeof(HeadlessChannelApplicationModelBinder), typeof(HeadlessChannelApplication))]
public HeadlessChannelApplicationUrlIdentifier ChannelApplicationIdentifier { get; set; }

Property Value

HeadlessChannelApplicationUrlIdentifier

ContentLanguageIdentifier

Content language identifier.

[PageParameter(typeof(ContentLanguageModelBinder), typeof(HeadlessChannelContentLanguage))]
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

Methods

Clone(HeadlessItemCloneCommandArguments)

Clones the selected headless item.

[PageCommand(Permission = "Create")]
public Task<ICommandResponse<RowActionResult>> Clone(HeadlessItemCloneCommandArguments args)

Parameters

args HeadlessItemCloneCommandArguments

Returns

Task<ICommandResponse<RowActionResult>>

ConfigurePage()

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

public override Task ConfigurePage()

Returns

Task

Delete(int)

Deletes listing item specified by the id parameter.

[PageCommand(Permission = "Delete")]
public Task<ICommandResponse> Delete(int id)

Parameters

id int

Returns

Task<ICommandResponse>

GetFilterFormComponentsContext()

Gets the form component context for the form components.

protected override Task<IFormContext> GetFilterFormComponentsContext()

Returns

Task<IFormContext>

GetFormItemsForClone(int, CancellationToken)

Gets the form items for cloning the selected headless item.

[PageCommand(Permission = "Create")]
public Task<ICommandResponse<GetHeadlessItemCloneFormItemsCommandResult>> GetFormItemsForClone(int headlessItemId, CancellationToken cancellationToken)

Parameters

headlessItemId int

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetHeadlessItemCloneFormItemsCommandResult>>

GetQuerySource()

Returns the query used as source for data.

protected override Task<ObjectQuery> GetQuerySource()

Returns

Task<ObjectQuery>

Query used as source for data.

RedirectToHeadlessItemDetail(int, CancellationToken)

Redirects to headless item detail.

[Obsolete("Method is no longer used by the system and will be removed.")]
[PageCommand(Permission = "View")]
public Task<ICommandResponse> RedirectToHeadlessItemDetail(int headlessItemId, CancellationToken cancellationToken)

Parameters

headlessItemId int

Identifier of the headless item.

cancellationToken CancellationToken

Cancellation instructions.

Returns

Task<ICommandResponse>