Class WebPagesApplication

Namespace

Kentico.Xperience.Admin.Websites.UIPages

Assembly

Kentico.Xperience.Admin.Websites.dll

Web pages application.

[UIPermission("View", "{$base.roles.permissions.accesschannel$}")]
[UIPermission("ManagePermissions", "{$base.roles.permissions.managepermissions$}")]
public sealed class WebPagesApplication : Page<WebPagesApplicationClientProperties>, IPage

Inheritance

object

Page<WebPagesApplicationClientProperties>

WebPagesApplication

Implements

IPage

Inherited Members

Page<WebPagesApplicationClientProperties>.ConfigurePage()

Page<WebPagesApplicationClientProperties>.ValidatePage()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

WebPagesApplication(IWebPageManagerFactory, IAuthenticatedUserAccessor, IContentLanguageModelRetriever, IServiceProvider)

Initializes an instance of WebPagesApplication class.

public WebPagesApplication(IWebPageManagerFactory webPageManagerFactory, IAuthenticatedUserAccessor authenticatedUserAccessor, IContentLanguageModelRetriever contentLanguageModelRetriever, IServiceProvider serviceProvider)

Parameters

webPageManagerFactory IWebPageManagerFactory

authenticatedUserAccessor IAuthenticatedUserAccessor

contentLanguageModelRetriever IContentLanguageModelRetriever

serviceProvider IServiceProvider

Fields

IDENTIFIER

Unique identifier of application.

public const string IDENTIFIER = "Kentico.Xperience.Application.WebPages"

Field Value

string

Properties

ApplicationIdentifier

Application identifier.

[PageParameter(typeof(WebPagesApplicationModelBinder), typeof(WebPagesApplication))]
public WebPagesApplicationUrlIdentifier ApplicationIdentifier { get; set; }

Property Value

WebPagesApplicationUrlIdentifier

Methods

CheckClonePageAclPermissions(CheckCloneWebPageAclPermissionsCommandArguments, CancellationToken)

Checks whether the user has permissions to clone a web page.

public Task<ICommandResponse<CheckCloneWebPageAclPermissionsCommandResult>> CheckClonePageAclPermissions(CheckCloneWebPageAclPermissionsCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args CheckCloneWebPageAclPermissionsCommandArguments

Check clone page ACL permissions command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<CheckCloneWebPageAclPermissionsCommandResult>>

CheckCollisions(CheckCollisionsCommandArguments, CancellationToken)

Checks web page URL path collisions between page subtree and target page subtree.

public Task<ICommandResponse<CheckCollisionsCommandResult>> CheckCollisions(CheckCollisionsCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args CheckCollisionsCommandArguments

Check collisions page command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<CheckCollisionsCommandResult>>

CheckMovePageRequirements(CheckMovePageRequirementsCommandArguments, CancellationToken)

Checks whether the requirements to move a web page were met.

public Task<ICommandResponse<CheckMovePageRequirementsCommandResult>> CheckMovePageRequirements(CheckMovePageRequirementsCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args CheckMovePageRequirementsCommandArguments

Check move page requirements command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<CheckMovePageRequirementsCommandResult>>

CheckSecurityMismatch(CheckSecurityMismatchCommandArguments, CancellationToken)

Checks mismatch in security settings between the target node and the page that should be moved including its children.

public Task<ICommandResponse<CheckSecurityMismatchCommandResult>> CheckSecurityMismatch(CheckSecurityMismatchCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args CheckSecurityMismatchCommandArguments

Check security mismatch page command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<CheckSecurityMismatchCommandResult>>

ClonePage(CloneWebPageCommandArguments, CancellationToken)

Clones specific web page.

public Task<ICommandResponse<CloneWebPageCommandResult>> ClonePage(CloneWebPageCommandArguments args, CancellationToken cancellationToken)

Parameters

args CloneWebPageCommandArguments

Clone web page command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<CloneWebPageCommandResult>>

ClonePageFormChange(CloneWebPageFormChangeCommandArguments, CancellationToken)

Handles the clone page 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<FormChangeResult>> ClonePageFormChange(CloneWebPageFormChangeCommandArguments args, CancellationToken cancellationToken)

Parameters

args CloneWebPageFormChangeCommandArguments

Clone page form change command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<FormChangeResult>>

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

Cancellation instruction.

Returns

Task<object>

Returns the form component command result.

ConfigureTemplateProperties(WebPagesApplicationClientProperties)

Gets the object representing client side template properties.

public override Task<WebPagesApplicationClientProperties> ConfigureTemplateProperties(WebPagesApplicationClientProperties properties)

Parameters

properties WebPagesApplicationClientProperties

Initialized properties object.

Returns

Task<WebPagesApplicationClientProperties>

CreateFolder(CreateFolderCommandArguments, CancellationToken)

Creates new folder.

public Task<ICommandResponse<CreateFolderCommandResult>> CreateFolder(CreateFolderCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args CreateFolderCommandArguments

Create folder command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<CreateFolderCommandResult>>

DeletePage(DeleteWebPageCommandArguments, CancellationToken)

Deletes web page.

public Task<ICommandResponse<DeleteWebPageCommandResult>> DeletePage(DeleteWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args DeleteWebPageCommandArguments

Delete page command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<DeleteWebPageCommandResult>>

DeletePageFormChange(DeleteSidePanelConfigurationValidateOrChangeArguments, CancellationToken)

Handles the form change command. The command is invoked when the value of delete side panel is changed.

public Task<ICommandResponse<FormChangeResult>> DeletePageFormChange(DeleteSidePanelConfigurationValidateOrChangeArguments args, CancellationToken cancellationToken = default)

Parameters

args DeleteSidePanelConfigurationValidateOrChangeArguments

Form change arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<FormChangeResult>>

DeletePageWithChildren(DeleteWebPageWithChildrenCommandArguments, CancellationToken)

Deletes web page with children.

public Task<ICommandResponse<DeleteWebPageCommandResult>> DeletePageWithChildren(DeleteWebPageWithChildrenCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args DeleteWebPageWithChildrenCommandArguments

Delete page command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<DeleteWebPageCommandResult>>

GetClonePageForm(GetCloneWebPageFormCommandArguments, CancellationToken)

Gets the form for cloning a web page.

public Task<ICommandResponse<GetCloneWebPageFormCommandResult>> GetClonePageForm(GetCloneWebPageFormCommandArguments args, CancellationToken cancellationToken)

Parameters

args GetCloneWebPageFormCommandArguments

Get clone web page form parameters.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<GetCloneWebPageFormCommandResult>>

GetDefaultRoute(IEnumerable<Route>)

Gets the route which is redirected to, when no route is selected.

protected override Route GetDefaultRoute(IEnumerable<Route> routes)

Parameters

routes IEnumerable<Route>

Returns

Route

GetDeleteSidePanelConfiguration(DeleteSidePanelConfigurationArguments, CancellationToken)

Gets configuration for delete side panel.

public Task<ICommandResponse<DeleteSidePanelConfiguration>> GetDeleteSidePanelConfiguration(DeleteSidePanelConfigurationArguments args, CancellationToken cancellationToken = default)

Parameters

args DeleteSidePanelConfigurationArguments

Side panel arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<DeleteSidePanelConfiguration>>

GetPermissions(GetPermissionsCommandArguments, CancellationToken)

Loads permissions for specified webpage item.

public Task<ICommandResponse<GetPermissionsCommandResult>> GetPermissions(GetPermissionsCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args GetPermissionsCommandArguments

Get permissions command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<GetPermissionsCommandResult>>

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

LoadLevel(LoadTreeDataCommandArguments, CancellationToken)

Loads child nodes for parent node.

public Task<ICommandResponse<LoadTreeDataResult>> LoadLevel(LoadTreeDataCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args LoadTreeDataCommandArguments

Load tree data arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<LoadTreeDataResult>>

LoadPagesForDelete(LoadPagesForDeleteCommandArguments, CancellationToken)

Load pages for delete.

public Task<ICommandResponse<LoadDataResult>> LoadPagesForDelete(LoadPagesForDeleteCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args LoadPagesForDeleteCommandArguments

Delete page command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<LoadDataResult>>

LoadTree(LoadTreeDataCommandArguments, CancellationToken)

Loads initial nodes for application.

public Task<ICommandResponse<LoadTreeDataResult>> LoadTree(LoadTreeDataCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args LoadTreeDataCommandArguments

Load tree data arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<LoadTreeDataResult>>

MovePage(MoveWebPageCommandArguments, CancellationToken)

Moves specified web page.

public Task<ICommandResponse<MoveWebPageCommandResult>> MovePage(MoveWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args MoveWebPageCommandArguments

Move page command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<MoveWebPageCommandResult>>