Class PageBuilderTab

Namespace

Kentico.Xperience.Admin.Websites.UIPages

Assembly

Kentico.Xperience.Admin.Websites.dll

Page for the page builder.

public sealed class PageBuilderTab : WebPageBase<PageBuilderPageClientProperties>, IPage

Inheritance

object

Page<PageBuilderPageClientProperties>

WebPageBase<PageBuilderPageClientProperties>

PageBuilderTab

Implements

IPage

Inherited Members

WebPageBase<PageBuilderPageClientProperties>.ConfigurePage()

WebPageBase<PageBuilderPageClientProperties>.ApplicationIdentifier

WebPageBase<PageBuilderPageClientProperties>.WebPageIdentifier

Page<PageBuilderPageClientProperties>.ValidatePage()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

PageBuilderTab(IAuthenticatedUserAccessor, IWebPageManagerFactory, IPageBuilderLinkGenerator, IHttpContextAccessor, IFormItemCollectionProvider, IFormComponentCommandInvoker, ITempPageBuilderDataPropagationUtils, IPageLinkGenerator)

Initializes an instance of the PageBuilderTab class.

public PageBuilderTab(IAuthenticatedUserAccessor authenticatedUserAccessor, IWebPageManagerFactory webPageManagerFactory, IPageBuilderLinkGenerator pageBuilderLinkGenerator, IHttpContextAccessor httpContextAccessor, IFormItemCollectionProvider formItemCollectionProvider, IFormComponentCommandInvoker formComponentCommandInvoker, ITempPageBuilderDataPropagationUtils tempPageBuilderDataPropagationUtils, IPageLinkGenerator pageLinkGenerator)

Parameters

authenticatedUserAccessor IAuthenticatedUserAccessor

Currently logged in user accessor.

webPageManagerFactory IWebPageManagerFactory

Web page manager factory.

pageBuilderLinkGenerator IPageBuilderLinkGenerator

Page builder link generator.

httpContextAccessor IHttpContextAccessor

HTTP context accessor to obtain request service provider from.

formItemCollectionProvider IFormItemCollectionProvider

Form item collection provider.

formComponentCommandInvoker IFormComponentCommandInvoker

Form component command invoker.

tempPageBuilderDataPropagationUtils ITempPageBuilderDataPropagationUtils

Manager for temporary page builder data.

pageLinkGenerator IPageLinkGenerator

Page link generator.

Methods

CancelScheduledPublish(PageBuilderCommandArgs, CancellationToken)

Cancels scheduled publish of the web page.

[PageCommand(CommandName = "CancelScheduledPublish", Permission = "View")]
public Task<ICommandResponse> CancelScheduledPublish(PageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args PageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CancelScheduledPublishAndEdit(PageBuilderCommandArgs, CancellationToken)

Cancels scheduled publish of the web page and allows edit.

[PageCommand(CommandName = "CancelScheduledPublishAndEdit", Permission = "View")]
public Task<ICommandResponse> CancelScheduledPublishAndEdit(PageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args PageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CancelScheduledUnpublish(CancellationToken)

Cancels scheduled unpublish of the web page.

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

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Change(FormSubmissionCommandArguments, CancellationToken)

Handles the form change command. The command is invoked whenever visibility conditions or form component configurators of the form need to be reevaluated to re-render the form.

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

Parameters

args FormSubmissionCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<FilterFormChangeResult>>

ChangeCreateSmartFolderForm(FormSubmissionCommandArguments, CancellationToken)

Handles the create smart folder form change command. The command is invoked whenever visibility conditions or form component configurators of the form need to be reevaluated to re-render the form.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<FilterFormChangeResult>> ChangeCreateSmartFolderForm(FormSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormSubmissionCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<FilterFormChangeResult>>

ChangeWorkflowStep(ChangeWorkflowStepPageBuilderCommandArgs, CancellationToken)

Changes the web page workflow step.

[PageCommand(CommandName = "ChangeWorkflowStep", Permission = "View")]
public Task<ICommandResponse> ChangeWorkflowStep(ChangeWorkflowStepPageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args ChangeWorkflowStepPageBuilderCommandArgs

Change workflow step submit arguments.

cancellationToken CancellationToken

Cancellation instruction.

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

Gets the object representing client side template properties.

public override Task<PageBuilderPageClientProperties> ConfigureTemplateProperties(PageBuilderPageClientProperties properties)

Parameters

properties PageBuilderPageClientProperties

Initialized properties object.

Returns

Task<PageBuilderPageClientProperties>

CreateAssetFolder(AssetFolderFormSubmissionCommandArguments)

Creates asset folder.

[PageCommand(Permission = "View")]
[Obsolete("Media libraries and their APIs are obsolete and will be discontinued in the future. Please migrate all media library files to Content hub and use their corresponding content item APIs.")]
public Task<ICommandResponse<AssetFolderFormSubmissionCommandResult>> CreateAssetFolder(AssetFolderFormSubmissionCommandArguments args)

Parameters

args AssetFolderFormSubmissionCommandArguments

Returns

Task<ICommandResponse<AssetFolderFormSubmissionCommandResult>>

CreateNewVersion(PageBuilderCommandArgs, CancellationToken)

Creates new Draft version of the web page.

[PageCommand(CommandName = "CreateNewVersion", Permission = "View")]
public Task<ICommandResponse> CreateNewVersion(PageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args PageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Discard(PageBuilderCommandArgs, CancellationToken)

Discards the Draft version of the web page.

[PageCommand(CommandName = "Discard", Permission = "View")]
public Task<ICommandResponse> Discard(PageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args PageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

GetAssetFolderForm(CancellationToken)

Gets form items for asset folder creation.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<GetAssetFolderFormCommandResult>> GetAssetFolderForm(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetAssetFolderFormCommandResult>>

GetFormItems(ComponentPropertiesGetFormItemsCommandArgs, CancellationToken)

Returns a collection of editing form items for given component specified by Identifier property of arguments to feed the Form.tsx with them.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<IEnumerable<IFormItemClientProperties>>> GetFormItems(ComponentPropertiesGetFormItemsCommandArgs arguments, CancellationToken cancellationToken)

Parameters

arguments ComponentPropertiesGetFormItemsCommandArgs

cancellationToken CancellationToken

Returns

Task<ICommandResponse<IEnumerable<IFormItemClientProperties>>>

GetFormItemsForMoveFolder(GetFormItemsArguments, CancellationToken)

Routes the command to the GetFormItemsForMoveFolder(GetFormItemsArguments, CancellationToken) method.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForMoveFolder(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetListingConfiguration(LoadListingConfigurationCommandArguments)

Returns listing configuration.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<LoadListingConfigurationCommandResult>> GetListingConfiguration(LoadListingConfigurationCommandArguments args)

Parameters

args LoadListingConfigurationCommandArguments

Returns

Task<ICommandResponse<LoadListingConfigurationCommandResult>>

GetMultiSourceAssetPanelProperties()

Gets the initial properties of multi source asset panel.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<GetMultiSourceAssetPanelPropertiesResult>> GetMultiSourceAssetPanelProperties()

Returns

Task<ICommandResponse<GetMultiSourceAssetPanelPropertiesResult>>

GetPageTemplates()

Return a list of filtered page templates for the current page.

[PageCommand(CommandName = "GetTemplates", Permission = "View")]
public Task<ICommandResponse<IEnumerable<PageTemplate>>> GetPageTemplates()

Returns

Task<ICommandResponse<IEnumerable<PageTemplate>>>

LoadContentItemAssetUrls(LoadContentItemAssetUrlsCommandArguments)

Loads asset URLs for given content items.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<RichTextContentItemAssetUrl[]>> LoadContentItemAssetUrls(LoadContentItemAssetUrlsCommandArguments args)

Parameters

args LoadContentItemAssetUrlsCommandArguments

Arguments.

Returns

Task<ICommandResponse<RichTextContentItemAssetUrl[]>>

LoadContentItemPanelItems(LoadContentItemPanelItemsCommandArguments)

Loads content item panel items.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<LoadContentItemPanelItemsResult>> LoadContentItemPanelItems(LoadContentItemPanelItemsCommandArguments args = null)

Parameters

args LoadContentItemPanelItemsCommandArguments

Returns

Task<ICommandResponse<LoadContentItemPanelItemsResult>>

LoadSelectorData(LoadSelectorDataCommandArguments, CancellationToken)

Loads data for the content item selector.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<LoadDataResult>> LoadSelectorData(LoadSelectorDataCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadSelectorDataCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<LoadDataResult>>

Lock(PageBuilderCommandArgs, CancellationToken)

Locks the web page language variant for editing by the current user.

[PageCommand(CommandName = "Lock", Permission = "View")]
public Task<ICommandResponse> Lock(PageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args PageBuilderCommandArgs

Lock command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

OverrideContentLock(PageBuilderCommandArgs, CancellationToken)

Releases a content lock held by a different user.

[PageCommand(CommandName = "OverrideContentLock", Permission = "View")]
public Task<ICommandResponse> OverrideContentLock(PageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args PageBuilderCommandArgs

Command arguments carrying the editing instance identifier.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Publish(PublishPageBuilderCommandArgs, CancellationToken)

Updates the web page and redirects to the publish page.

[PageCommand(CommandName = "Publish", Permission = "View")]
public Task<ICommandResponse> Publish(PublishPageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args PublishPageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Save(PageBuilderCommandArgs, CancellationToken)

Saves page data changes.

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

Parameters

args PageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

ShareablePreview(ShareablePreviewPageBuilderCommandArgs, CancellationToken)

Redirects to the page with shareable preview.

[PageCommand(CommandName = "ShareablePreview", Permission = "View")]
public Task<ICommandResponse> ShareablePreview(ShareablePreviewPageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args ShareablePreviewPageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Unlock(UnlockPageBuilderCommandArgs, CancellationToken)

Unlocks the web page language variant to allow editing by other users.

[PageCommand(CommandName = "Unlock", Permission = "View")]
public Task<ICommandResponse> Unlock(UnlockPageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args UnlockPageBuilderCommandArgs

Unlock command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Unpublish(CancellationToken)

Redirects to the page with unpublishing options.

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

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

ValidateComponents(ComponentPropertiesFormSubmissionCommandArgs, CancellationToken)

Validates values of incoming collection of editing form components and returns a collection of updated form components and a flag if validation succeeded.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<ComponentPropertiesFormSubmissionCommandResult>> ValidateComponents(ComponentPropertiesFormSubmissionCommandArgs arguments, CancellationToken cancellationToken)

Parameters

arguments ComponentPropertiesFormSubmissionCommandArgs

cancellationToken CancellationToken

Returns

Task<ICommandResponse<ComponentPropertiesFormSubmissionCommandResult>>

Versions(VersionsPageBuilderCommandArgs, CancellationToken)

Redirects to the page with web page versions.

[PageCommand(CommandName = "Versions", Permission = "View")]
public Task<ICommandResponse> Versions(VersionsPageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args VersionsPageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>