Class WebPagePermissions

Namespace

Kentico.Xperience.Admin.Websites.UIPages

Assembly

Kentico.Xperience.Admin.Websites.dll

Web page permissions properties page.

public sealed class WebPagePermissions : WebPagePermissionsBase<WebPagePermissionsClientProperties>, IPage

Inheritance

object

Page<WebPagePermissionsClientProperties>

WebPageBase<WebPagePermissionsClientProperties>

WebPagePermissionsBase<WebPagePermissionsClientProperties>

WebPagePermissions

Implements

IPage

Inherited Members

WebPageBase<WebPagePermissionsClientProperties>.ConfigurePage()

WebPageBase<WebPagePermissionsClientProperties>.ApplicationIdentifier

WebPageBase<WebPagePermissionsClientProperties>.WebPageIdentifier

Page<WebPagePermissionsClientProperties>.ValidatePage()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

WebPagePermissions(IAuthenticatedUserAccessor, IWebPageManagerFactory, IPageLinkGenerator, IRoleInfoProvider, IUIPermissionEvaluator, ILocalizationService)

Initializes a new instance of the WebPagePermissions class.

public WebPagePermissions(IAuthenticatedUserAccessor userAccessor, IWebPageManagerFactory webPageManagerFactory, IPageLinkGenerator pageLinkGenerator, IRoleInfoProvider roleInfoProvider, IUIPermissionEvaluator uiPermissionEvaluator, ILocalizationService localizationService)

Parameters

userAccessor IAuthenticatedUserAccessor

webPageManagerFactory IWebPageManagerFactory

pageLinkGenerator IPageLinkGenerator

roleInfoProvider IRoleInfoProvider

uiPermissionEvaluator IUIPermissionEvaluator

localizationService ILocalizationService

Methods

BreakInheritance(CancellationToken)

Break ACL inheritance for the current web page.

[PageCommand(CommandName = "BreakInheritance", Permission = "ManagePermissions")]
public Task<ICommandResponse> BreakInheritance(CancellationToken cancellationToken)

Parameters

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

Cancellation instruction.

Returns

Task<object>

Returns the form component command result.

ConfigureTemplateProperties(WebPagePermissionsClientProperties)

Gets the object representing client side template properties.

public override Task<WebPagePermissionsClientProperties> ConfigureTemplateProperties(WebPagePermissionsClientProperties properties)

Parameters

properties WebPagePermissionsClientProperties

Initialized properties object.

Returns

Task<WebPagePermissionsClientProperties>

GetConfiguration(CancellationToken)

Gets the current ACL configuration.

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

Parameters

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse>

GetDataForAddAclRolesForm(GetDataForAddAclRoleFormCommandArguments, CancellationToken)

Returns data for the form for adding roles into ACL.

[PageCommand(CommandName = "GetDataForAddAclRolesForm", Permission = "View")]
public Task<ICommandResponse> GetDataForAddAclRolesForm(GetDataForAddAclRoleFormCommandArguments args, CancellationToken cancellationToken)

Parameters

args GetDataForAddAclRoleFormCommandArguments

Command arguments.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<ICommandResponse>

RestoreInheritance(CancellationToken)

Restore ACL inheritance for the current web page.

[PageCommand(CommandName = "RestoreInheritance", Permission = "ManagePermissions")]
public Task<ICommandResponse> RestoreInheritance(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse>

SavePermissions(SavePermissionsCommandArguments, CancellationToken)

Saves the permissions configuration.

[PageCommand(CommandName = "SavePermissions", Permission = "ManagePermissions")]
public Task<ICommandResponse> SavePermissions(SavePermissionsCommandArguments args, CancellationToken cancellationToken)

Parameters

args SavePermissionsCommandArguments

Command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse>

ValidateAclRoles(ValidateAclRolesCommandArguments, CancellationToken)

Validates the form data for adding roles into ACL.

[PageCommand(CommandName = "ValidateAclRoles", Permission = "ManagePermissions")]
public Task<ICommandResponse> ValidateAclRoles(ValidateAclRolesCommandArguments args, CancellationToken cancellationToken)

Parameters

args ValidateAclRolesCommandArguments

Command arguments.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<ICommandResponse>

Returns result with metadata for the selected roles.