View Source

Interface IElementContainerPermissionService

Manages permissions for element container access.

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IElementContainerPermissionService

Methods

AuthorizeAccessAsync(IUser, IEnumerable<Guid>, ISet<string>)

Authorize that a user has access to element containers.

Declaration

Task<ElementAuthorizationStatus> AuthorizeAccessAsync(IUser user, IEnumerable<Guid> containerKeys, ISet<string> permissionsToCheck)

Parameters

Type	Name	Description
IUser	user	IUser to authorize.
IEnumerable<Guid>	containerKeys	The identifiers of the element containers to check for access.
ISet<string>	permissionsToCheck	The collection of permissions to authorize.

Returns

Type	Description
Task<ElementAuthorizationStatus>	A task resolving into a ElementAuthorizationStatus.

AuthorizeAccessAsync(IUser, Guid, string)

Authorize that a user has access to an element container.

Declaration

Task<ElementAuthorizationStatus> AuthorizeAccessAsync(IUser user, Guid containerKey, string permissionToCheck)

Parameters

Type	Name	Description
IUser	user	IUser to authorize.
Guid	containerKey	The identifier of the element container to check for access.
string	permissionToCheck	The permission to authorize.

Returns

Type	Description
Task<ElementAuthorizationStatus>	A task resolving into a ElementAuthorizationStatus.

AuthorizeBinAccessAsync(IUser, ISet<string>)

Authorize that a user is allowed to perform actions on the element container recycle bin.

Declaration

Task<ElementAuthorizationStatus> AuthorizeBinAccessAsync(IUser user, ISet<string> permissionsToCheck)

Parameters

Type	Name	Description
IUser	user	IUser to authorize.
ISet<string>	permissionsToCheck	The collection of permissions to authorize.

Returns

Type	Description
Task<ElementAuthorizationStatus>	A task resolving into a ElementAuthorizationStatus.

AuthorizeBinAccessAsync(IUser, string)

Authorize that a user is allowed to perform action on the element container recycle bin.

Declaration

Task<ElementAuthorizationStatus> AuthorizeBinAccessAsync(IUser user, string permissionToCheck)

Parameters

Type	Name	Description
IUser	user	IUser to authorize.
string	permissionToCheck	The permission to authorize.

Returns

Type	Description
Task<ElementAuthorizationStatus>	A task resolving into a ElementAuthorizationStatus.

AuthorizeRootAccessAsync(IUser, ISet<string>)

Authorize that a user is allowed to perform actions on the element container root.

Declaration

Task<ElementAuthorizationStatus> AuthorizeRootAccessAsync(IUser user, ISet<string> permissionsToCheck)

Parameters

Type	Name	Description
IUser	user	IUser to authorize.
ISet<string>	permissionsToCheck	The collection of permissions to authorize.

Returns

Type	Description
Task<ElementAuthorizationStatus>	A task resolving into a ElementAuthorizationStatus.

AuthorizeRootAccessAsync(IUser, string)

Authorize that a user is allowed to perform action on the element container root.

Declaration

Task<ElementAuthorizationStatus> AuthorizeRootAccessAsync(IUser user, string permissionToCheck)

Parameters

Type	Name	Description
IUser	user	IUser to authorize.
string	permissionToCheck	The permission to authorize.

Returns

Type	Description
Task<ElementAuthorizationStatus>	A task resolving into a ElementAuthorizationStatus.