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>.ApplicationIdentifier

WebPageBase<PageBuilderPageClientProperties>.WebPageIdentifier

WebPageBase<PageBuilderPageClientProperties>.ConfigurePage()

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, IFormDataBinder, ILocalizationService, ITempPageBuilderDataPropagationUtils, IPageBuilderConfigurationStorageProcessor, IPageLinkGenerator)

Initializes an instance of the PageBuilderTab class.

public PageBuilderTab(IAuthenticatedUserAccessor authenticatedUserAccessor, IWebPageManagerFactory webPageManagerFactory, IPageBuilderLinkGenerator pageBuilderLinkGenerator, IHttpContextAccessor httpContextAccessor, IFormItemCollectionProvider formItemCollectionProvider, IFormComponentCommandInvoker formComponentCommandInvoker, IFormDataBinder formDataBinder, ILocalizationService localizationService, ITempPageBuilderDataPropagationUtils tempPageBuilderDataManager, IPageBuilderConfigurationStorageProcessor pageBuilderConfigurationStorageProcessor, 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.

formDataBinder IFormDataBinder

Form data binder.

localizationService ILocalizationService

Localization service.

tempPageBuilderDataManager ITempPageBuilderDataPropagationUtils

Manager for temporary page builder data.

pageBuilderConfigurationStorageProcessor IPageBuilderConfigurationStorageProcessor

Page builder configuration storage processor.

pageLinkGenerator IPageLinkGenerator

Page link generator.

Methods

Archive(CancellationToken)

Archives the web page.

[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>

CancelScheduledPublish(PageBuilderCommandArgs, CancellationToken)

Cancels scheduled publish of the web page.

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.

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.

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

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CascadePublish(PageBuilderCommandArgs, CancellationToken)

Updates the web page and redirects to the publish page.

[Obsolete("Use Publish command instead.")]
[ObsoleteSince(29, 1)]
public Task<ICommandResponse> CascadePublish(PageBuilderCommandArgs args, CancellationToken cancellationToken = default)

Parameters

args PageBuilderCommandArgs

Cascade publish submit arguments.

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.

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.

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

Parameters

args FormSubmissionCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<FilterFormChangeResult>>

ChangeWorkflowStep(PageBuilderCommandArgs, CancellationToken)

Changes the web page workflow step.

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

Parameters

args PageBuilderCommandArgs

Change workflow step submit arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse>

CloneSmartFolder(CloneSmartFolderArguments, CancellationToken)

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

public Task<ICommandResponse<CloneSmartFolderResult>> CloneSmartFolder(CloneSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args CloneSmartFolderArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<CloneSmartFolderResult>>

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(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.

public Task<ICommandResponse<AssetFolderFormSubmissionCommandResult>> CreateAssetFolder(AssetFolderFormSubmissionCommandArguments args)

Parameters

args AssetFolderFormSubmissionCommandArguments

Returns

Task<ICommandResponse<AssetFolderFormSubmissionCommandResult>>

CreateFolder(CreateFolderArguments, CancellationToken)

Routes the command to the CreateFolder(CreateFolderArguments, int, CancellationToken) method.

public Task<ICommandResponse<CreateFolderResult>> CreateFolder(CreateFolderArguments args, CancellationToken cancellationToken)

Parameters

args CreateFolderArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<CreateFolderResult>>

CreateNewVersion(PageBuilderCommandArgs, CancellationToken)

Creates new Draft version of the web page.

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

Parameters

args PageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CreateSmartFolder(CreateSmartFolderArguments, CancellationToken)

Routes the command to the CreateSmartFolder(CreateSmartFolderArguments, int, CancellationToken) method.

public Task<ICommandResponse<CreateSmartFolderResult>> CreateSmartFolder(CreateSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args CreateSmartFolderArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<CreateSmartFolderResult>>

CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments, CancellationToken)

Routes the command to the CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments, CancellationToken, int?, bool) method.

public Task<ICommandResponse<CreateSmartFolderConfirmFilterResult>> CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments args, CancellationToken cancellationToken)

Parameters

args CreateSmartFolderConfirmFilterArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<CreateSmartFolderConfirmFilterResult>>

Discard(PageBuilderCommandArgs, CancellationToken)

Discards the Draft version of the web page.

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

Parameters

args PageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

DoesFilterSupportDelivery(FilterDeliverySupportArguments, CancellationToken)

Routes the command to the DoesFilterSupportDelivery(FilterDeliverySupportArguments, CancellationToken) method.

public Task<ICommandResponse<FilterDeliverySupportResult>> DoesFilterSupportDelivery(FilterDeliverySupportArguments args, CancellationToken cancellationToken)

Parameters

args FilterDeliverySupportArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<FilterDeliverySupportResult>>

EnableContentDeliveryForSmartFolder(EnableContentDeliveryForSmartFolderArguments, CancellationToken)

Routes the command to the SaveSmartFolder(SaveSmartFolderArguments, int, CancellationToken) method.

public Task<ICommandResponse> EnableContentDeliveryForSmartFolder(EnableContentDeliveryForSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args EnableContentDeliveryForSmartFolderArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

GetAssetFolderForm(CancellationToken)

Gets form items for asset folder creation.

public Task<ICommandResponse<GetAssetFolderFormCommandResult>> GetAssetFolderForm(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetAssetFolderFormCommandResult>>

GetFolder(GetFolderArguments, CancellationToken)

Routes the command to the GetFolder(GetFolderArguments, CancellationToken) method.

public Task<ICommandResponse<Folder>> GetFolder(GetFolderArguments args, CancellationToken cancellationToken)

Parameters

args GetFolderArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<Folder>>

GetFolderPath(GetFolderArguments, CancellationToken)

Routes the command to the GetFolderPath(GetFolderArguments, CancellationToken) method.

public Task<ICommandResponse<ICollection<Folder>>> GetFolderPath(GetFolderArguments args, CancellationToken cancellationToken)

Parameters

args GetFolderArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<ICollection<Folder>>>

GetFolderTreeViewActions()

Gets actions for the asset folder tree view component.

public Task<ICommandResponse<GetAssetFolderTreeViewActionsCommandResult>> GetFolderTreeViewActions()

Returns

Task<ICommandResponse<GetAssetFolderTreeViewActionsCommandResult>>

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.

public Task<ICommandResponse<IEnumerable<IFormItemClientProperties>>> GetFormItems(ComponentPropertiesGetFormItemsCommandArgs arguments, CancellationToken cancellationToken)

Parameters

arguments ComponentPropertiesGetFormItemsCommandArgs

cancellationToken CancellationToken

Returns

Task<ICommandResponse<IEnumerable<IFormItemClientProperties>>>

GetFormItemsForCloneSmartFolder(GetFormItemsArguments, CancellationToken)

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

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForCloneSmartFolder(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForCreateFolder(GetFormItemsArguments, CancellationToken)

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

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForCreateFolder(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForCreateSmartFolder(CancellationToken)

Routes the command to the Kentico.Xperience.Admin.Base.ISmartFolderCommandManager.GetFormItemsForCreateSmartFolder(System.Threading.CancellationToken) method.

public Task<ICommandResponse<GetFormItemsForCreateSmartFolderResult>> GetFormItemsForCreateSmartFolder(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsForCreateSmartFolderResult>>

GetFormItemsForMoveFolder(GetFormItemsArguments, CancellationToken)

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

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForMoveFolder(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForRenameFolder(GetFormItemsArguments, CancellationToken)

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

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForRenameFolder(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForRenameSmartFolder(GetFormItemsArguments, CancellationToken)

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

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForRenameSmartFolder(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForSaveSmartFolder(CancellationToken)

Routes the command to the Kentico.Xperience.Admin.Base.ISmartFolderCommandManager.GetFormItemsForSaveSmartFolder(System.Threading.CancellationToken) method.

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForSaveSmartFolder(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetListingConfiguration(LoadListingConfigurationCommandArguments)

Returns listing configuration.

public Task<ICommandResponse<LoadListingConfigurationCommandResult>> GetListingConfiguration(LoadListingConfigurationCommandArguments args)

Parameters

args LoadListingConfigurationCommandArguments

Returns

Task<ICommandResponse<LoadListingConfigurationCommandResult>>

GetMultiSourceAssetPanelProperties()

Gets the initial properties of multi source asset panel.

public Task<ICommandResponse<GetMultiSourceAssetPanelPropertiesResult>> GetMultiSourceAssetPanelProperties()

Returns

Task<ICommandResponse<GetMultiSourceAssetPanelPropertiesResult>>

GetPageTemplates()

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

public Task<ICommandResponse<IEnumerable<PageTemplate>>> GetPageTemplates()

Returns

Task<ICommandResponse<IEnumerable<PageTemplate>>>

GetSmartFolderFilter(GetSmartFolderFilterArguments, CancellationToken)

Routes the command to the GetSmartFolderFilter(GetSmartFolderFilterArguments, CancellationToken) method.

public Task<ICommandResponse<GetSmartFolderFilterResult>> GetSmartFolderFilter(GetSmartFolderFilterArguments args, CancellationToken cancellationToken)

Parameters

args GetSmartFolderFilterArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetSmartFolderFilterResult>>

GetSmartFolders(GetSmartFoldersArguments, CancellationToken)

Routes the command to the GetSmartFolders(GetSmartFoldersArguments, CancellationToken) method.

public Task<ICommandResponse<GetSmartFoldersResult>> GetSmartFolders(GetSmartFoldersArguments args, CancellationToken cancellationToken)

Parameters

args GetSmartFoldersArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetSmartFoldersResult>>

IsSmartFolderDeliverySupported(SmartFolderDeliverySupportArguments, CancellationToken)

Routes the command to the IsSmartFolderDeliverySupported(SmartFolderDeliverySupportArguments, CancellationToken) method.

public Task<ICommandResponse<SmartFolderDeliverySupportResult>> IsSmartFolderDeliverySupported(SmartFolderDeliverySupportArguments args, CancellationToken cancellationToken)

Parameters

args SmartFolderDeliverySupportArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<SmartFolderDeliverySupportResult>>

LoadAssetFolders(LoadAssetFoldersCommandArguments)

Loads assets folders.

public Task<ICommandResponse<LoadAssetFoldersResult>> LoadAssetFolders(LoadAssetFoldersCommandArguments args)

Parameters

args LoadAssetFoldersCommandArguments

Returns

Task<ICommandResponse<LoadAssetFoldersResult>>

LoadAssetItems(LoadAssetItemsCommandArguments)

Loads assets panel items.

public Task<ICommandResponse<LoadAssetItemsResult>> LoadAssetItems(LoadAssetItemsCommandArguments args)

Parameters

args LoadAssetItemsCommandArguments

Returns

Task<ICommandResponse<LoadAssetItemsResult>>

LoadAssetLibraries()

Loads assets libraries.

public Task<ICommandResponse<LoadAssetLibrariesResult>> LoadAssetLibraries()

Returns

Task<ICommandResponse<LoadAssetLibrariesResult>>

LoadContentItemAssetUrls(LoadContentItemAssetUrlsCommandArguments)

Loads asset URLs for given content items.

public Task<ICommandResponse<RichTextContentItemAssetUrl[]>> LoadContentItemAssetUrls(LoadContentItemAssetUrlsCommandArguments args)

Parameters

args LoadContentItemAssetUrlsCommandArguments

Arguments.

Returns

Task<ICommandResponse<RichTextContentItemAssetUrl[]>>

LoadContentItemPanelItems(LoadContentItemPanelItemsCommandArguments)

Loads content item panel items.

public Task<ICommandResponse<LoadContentItemPanelItemsResult>> LoadContentItemPanelItems(LoadContentItemPanelItemsCommandArguments args = null)

Parameters

args LoadContentItemPanelItemsCommandArguments

Returns

Task<ICommandResponse<LoadContentItemPanelItemsResult>>

LoadFilteredTree(LoadFilteredTreeDataCommandArguments, CancellationToken)

Loads filtered tree for application.

public Task<ICommandResponse<LoadTreeDataResult>> LoadFilteredTree(LoadFilteredTreeDataCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args LoadFilteredTreeDataCommandArguments

Load filtered tree data arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<LoadTreeDataResult>>

LoadLevelWebPagePanelTree(LoadTreeDataCommandArguments, CancellationToken)

Loads child nodes for parent node.

public Task<ICommandResponse<LoadTreeDataResult>> LoadLevelWebPagePanelTree(LoadTreeDataCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadTreeDataCommandArguments

Load tree data arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<LoadTreeDataResult>>

LoadSelectorData(LoadSelectorDataCommandArguments, CancellationToken)

Loads data for the content item selector.

public Task<ICommandResponse<LoadDataResult>> LoadSelectorData(LoadSelectorDataCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadSelectorDataCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<LoadDataResult>>

LoadWebPageLinks(LoadWebPageLinkItemsCommandArguments, CancellationToken)

Returns web page links for given identifiers.

public Task<ICommandResponse<LoadWebPageLinkItemsResult>> LoadWebPageLinks(LoadWebPageLinkItemsCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadWebPageLinkItemsCommandArguments

Links parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadWebPageLinkItemsResult>>

LoadWebPagePanelItems(LoadWebPagePanelItemsCommandArguments, CancellationToken)

Returns web page panel items for a given node.

public Task<ICommandResponse<LoadWebPagePanelItemsResult>> LoadWebPagePanelItems(LoadWebPagePanelItemsCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadWebPagePanelItemsCommandArguments

Level parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadWebPagePanelItemsResult>>

LoadWebPagePanelTree(LoadTreeDataCommandArguments, CancellationToken)

Returns child webPages for a given node.

public Task<ICommandResponse<LoadTreeDataResult>> LoadWebPagePanelTree(LoadTreeDataCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadTreeDataCommandArguments

Subtree parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadTreeDataResult>>

MassMove(IEnumerable<int>, MoveContentItemModel, CancellationToken)

Moves multiple content items to a folder specified by the model.

public Task<ICommandResponse<MassActionResult>> MassMove(IEnumerable<int> identifiers, MoveContentItemModel model, CancellationToken cancellationToken)

Parameters

identifiers IEnumerable<int>

Ids of the content items to be moved.

model MoveContentItemModel

Model describing where to move the content items.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<MassActionResult>>

MoveContentItem(int, MoveContentItemModel, CancellationToken)

Moves a content item to a folder specified by the model.

public Task<ICommandResponse<RowActionResult>> MoveContentItem(int id, MoveContentItemModel model, CancellationToken cancellationToken)

Parameters

id int

Id of the content item to be moved.

model MoveContentItemModel

Model describing where to move the content item.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<RowActionResult>>

MoveFolder(MoveFolderArguments, CancellationToken)

Routes the command to the MoveFolder(MoveFolderArguments, int, CancellationToken) method.

public Task<ICommandResponse<MoveFolderResult>> MoveFolder(MoveFolderArguments args, CancellationToken cancellationToken)

Parameters

args MoveFolderArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<MoveFolderResult>>

MoveItemFormChange(FormChangeCommandArguments, CancellationToken)

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

public Task<ICommandResponse<FormChangeResult>> MoveItemFormChange(FormChangeCommandArguments args, CancellationToken cancellationToken)

Parameters

args FormChangeCommandArguments

Form change command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<FormChangeResult>>

Publish(PageBuilderCommandArgs, CancellationToken)

Updates the web page and redirects to the publish page.

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

Parameters

args PageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

RenameFolder(RenameFolderArguments, CancellationToken)

Routes the command to the RenameFolder(RenameFolderArguments, int, CancellationToken) method.

public Task<ICommandResponse<RenameFolderResult>> RenameFolder(RenameFolderArguments args, CancellationToken cancellationToken)

Parameters

args RenameFolderArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<RenameFolderResult>>

RenameSmartFolder(RenameSmartFolderArguments, CancellationToken)

Routes the command to the RenameSmartFolder(RenameSmartFolderArguments, CancellationToken) method.

public Task<ICommandResponse<RenameFolderResult>> RenameSmartFolder(RenameSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args RenameSmartFolderArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<RenameFolderResult>>

Save(PageBuilderCommandArgs, CancellationToken)

Saves page data changes.

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

Parameters

args PageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

SaveSmartFolder(SaveSmartFolderArguments, CancellationToken)

Routes the command to the SaveSmartFolder(SaveSmartFolderArguments, int, CancellationToken) method.

public Task<ICommandResponse<SaveSmartFolderResult>> SaveSmartFolder(SaveSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args SaveSmartFolderArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<SaveSmartFolderResult>>

Unpublish(CancellationToken)

Redirects to the page with unpublishing options.

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

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

UploadAssets(UploadAssetsCommandArguments)

Upload files to media library.

public Task<ICommandResponse<UploadAssetsCommandResult>> UploadAssets(UploadAssetsCommandArguments args)

Parameters

args UploadAssetsCommandArguments

Upload command arguments.

Returns

Task<ICommandResponse<UploadAssetsCommandResult>>

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.

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.

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

Parameters

args VersionsPageBuilderCommandArgs

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>