Table of Contents

Interface IWebPageAclManager

Namespace
CMS.Websites
Assembly
CMS.Websites.dll

Provides management API for web page ACL configuration.

public interface IWebPageAclManager
Extension Methods

Remarks

Newly created web pages inherit the ACL permissions from their parent by default. Use this interface in order to break the inheritance and modify custom ACL permissions.

Methods

BreakInheritance(int, CancellationToken)

Breaks the inheritance of ACL permissions and copies the currently inherited ACL permissions into the web page.

Task<bool> BreakInheritance(int webPageItemId, CancellationToken cancellationToken = default)

Parameters

webPageItemId int

Identifier of the web page.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

True if the inheritance was broken successfully, false otherwise.

Remarks

Permissions inheritance cannot be broken for the root page.

Exceptions

ArgumentException

Thrown when webPageItemId represents a website root.

InvalidOperationException

Thrown when web page specified by webPageItemId does not exist.

GetPermissions(int, CancellationToken)

Retrieves WebPageAclConfigurationDescriptor for the web page identified by webPageItemId.

Task<WebPageAclConfigurationDescriptor> GetPermissions(int webPageItemId, CancellationToken cancellationToken = default)

Parameters

webPageItemId int

Identifier of the web page or 0 for the website root.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<WebPageAclConfigurationDescriptor>

Exceptions

InvalidOperationException

Thrown when web page specified by webPageItemId does not exist.

RestoreInheritance(int, CancellationToken)

Restores the inheritance of permissions for the specified web page.

Task<bool> RestoreInheritance(int webPageItemId, CancellationToken cancellationToken = default)

Parameters

webPageItemId int

Identifier of the web page.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

True if the inheritance was restored successfully, false otherwise.

Remarks

The ACL corresponding to the web page is deleted in the process. The web page will inherit the ACL permissions from its parent. Permissions inheritance cannot be restored for the website root.

Exceptions

ArgumentException

Thrown when webPageItemId represents a website root.

InvalidOperationException

Thrown when web page specified by webPageItemId does not exist.

SetPermissions(int, WebPageAclConfiguration, CancellationToken)

Sets the web page ACL permissions according to the specified configuration.

Task<bool> SetPermissions(int webPageItemId, WebPageAclConfiguration webPageAclConfiguration, CancellationToken cancellationToken = default)

Parameters

webPageItemId int

Identifier of the web page or 0 for the website root.

webPageAclConfiguration WebPageAclConfiguration

Web pace ACL configuration object.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

True if the permissions were updated successfully, false if the given web page has the permission inheritance active so that the permissions cannot be saved.

Remarks

The ACL permissions can be set only to a web page that does not inherit permissions from its parent web page. Use BreakInheritance(int, CancellationToken) method to break the inheritance.

Exceptions

InvalidOperationException

Thrown when web page specified by webPageItemId does not exist.

See Also

IWebPageAclManagerFactory