Class HeadlessContentTab

Namespace

Kentico.Xperience.Admin.Headless.UIPages

Assembly

Kentico.Xperience.Admin.Headless.dll

Page for editing headless item content.

public sealed class HeadlessContentTab : HeadlessItemBase<HeadlessContentTabClientProperties>, IPage

Inheritance

object

Page<HeadlessContentTabClientProperties>

HeadlessItemBase<HeadlessContentTabClientProperties>

HeadlessContentTab

Implements

IPage

Inherited Members

Page<HeadlessContentTabClientProperties>.ConfigurePage()

Page<HeadlessContentTabClientProperties>.ValidatePage()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

HeadlessContentTab(IContentLanguageRetriever, IUIPermissionEvaluator, IContentItemDataInfoRetriever, IHeadlessItemManagerFactory, IAuthenticatedUserAccessor, IFormComponentCommandInvoker, IPageLinkGenerator, IWorkflowStepRoleArbiter, ICoveringWorkflowRetriever)

Initializes a new instance of HeadlessContentTab.

public HeadlessContentTab(IContentLanguageRetriever contentLanguageRetriever, IUIPermissionEvaluator uiPermissionEvaluator, IContentItemDataInfoRetriever contentItemDataInfoRetriever, IHeadlessItemManagerFactory headlessItemManagerFactory, IAuthenticatedUserAccessor authenticatedUserAccessor, IFormComponentCommandInvoker formComponentCommandInvoker, IPageLinkGenerator pageLinkGenerator, IWorkflowStepRoleArbiter workflowStepRoleArbiter, ICoveringWorkflowRetriever coveringWorkflowRetriever)

Parameters

contentLanguageRetriever IContentLanguageRetriever

uiPermissionEvaluator IUIPermissionEvaluator

contentItemDataInfoRetriever IContentItemDataInfoRetriever

headlessItemManagerFactory IHeadlessItemManagerFactory

authenticatedUserAccessor IAuthenticatedUserAccessor

formComponentCommandInvoker IFormComponentCommandInvoker

pageLinkGenerator IPageLinkGenerator

workflowStepRoleArbiter IWorkflowStepRoleArbiter

coveringWorkflowRetriever ICoveringWorkflowRetriever

Methods

Archive(CancellationToken)

Archives the content item.

[Obsolete("Archive status was replaced by Unpublished status, use Unpublish instead.")]
[ObsoleteSince(29, 2)]
public Task<ICommandResponse> Archive(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CascadePublish(PublishHeadlessItemCommandArguments, CancellationToken)

Updates the current headless item and redirects to the cascade publish page.

public Task<ICommandResponse> CascadePublish(PublishHeadlessItemCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args PublishHeadlessItemCommandArguments

Publish submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Change(FormSubmissionCommandArguments, CancellationToken)

Update form on change.

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(PublishHeadlessItemCommandArguments, CancellationToken)

Updates the current headless item and redirects to the change workflow step page.

public Task<ICommandResponse> ChangeWorkflowStep(PublishHeadlessItemCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args PublishHeadlessItemCommandArguments

Publish submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

ComponentCommand(FormComponentCommandModel, CancellationToken)

Handles the form component command invocation.

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(HeadlessContentTabClientProperties)

Gets the object representing client side template properties.

public override Task<HeadlessContentTabClientProperties> ConfigureTemplateProperties(HeadlessContentTabClientProperties properties)

Parameters

properties HeadlessContentTabClientProperties

Initialized properties object.

Returns

Task<HeadlessContentTabClientProperties>

CreateNewVersion(CancellationToken)

Creates new Draft version of content item.

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

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Delete(CancellationToken)

Command handling click on Delete button.

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

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Discard(CancellationToken)

Command handling click on Discard button.

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

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Publish(PublishHeadlessItemCommandArguments, CancellationToken)

Publishes the current headless item.

public Task<ICommandResponse> Publish(PublishHeadlessItemCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args PublishHeadlessItemCommandArguments

Publish submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Rename(RenameCommandArguments, CancellationToken)

Updates headless item display name.

public Task<ICommandResponse> Rename(RenameCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args RenameCommandArguments

Rename command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse>

Save(FormSubmissionCommandArguments, CancellationToken)

Saves page data changes.

public Task<ICommandResponse> Save(FormSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormSubmissionCommandArguments

Submission arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Unpublish(CancellationToken)

Unpublishes the headless item.

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

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Versions(VersionsHeadlessItemCommandArguments, CancellationToken)

Command handling click on Versions button.

public Task<ICommandResponse> Versions(VersionsHeadlessItemCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args VersionsHeadlessItemCommandArguments

Versions submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>