Interface IContentPermissionService

Manages permissions for content access.

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IContentPermissionService

Methods

View Source

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

Authorize that a user has access to content items.

Declaration

Task<ContentAuthorizationStatus> AuthorizeAccessAsync(IUser user, IEnumerable<Guid> contentKeys, ISet<string> permissionsToCheck)

Parameters

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

Returns

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

View Source

AuthorizeAccessAsync(IUser, Guid, string)

Authorize that a user has access to a content item.

Declaration

Task<ContentAuthorizationStatus> AuthorizeAccessAsync(IUser user, Guid contentKey, string permissionToCheck)

Parameters

Type	Name	Description
IUser	user	IUser to authorize.
Guid	contentKey	The identifier of the content item to check for access.
string	permissionToCheck	The permission to authorize.

Returns

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

View Source

AuthorizeBinAccessAsync(IUser, ISet<string>)

Authorize that a user is allowed to perform actions on the content bin item.

Declaration

Task<ContentAuthorizationStatus> 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<ContentAuthorizationStatus>	A task resolving into a ContentAuthorizationStatus.

View Source

AuthorizeBinAccessAsync(IUser, string)

Authorize that a user is allowed to perform action on the content bin item.

Declaration

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

Parameters

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

Returns

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

View Source

AuthorizeCultureAccessAsync(IUser, ISet<string>)

Authorize that a user has access to specific cultures

Declaration

Task<ContentAuthorizationStatus> AuthorizeCultureAccessAsync(IUser user, ISet<string> culturesToCheck)

Parameters

Type	Name	Description
IUser	user	IUser to authorize.
ISet<string>	culturesToCheck	The collection of cultures to authorize.

Returns

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

View Source

AuthorizeDescendantsAccessAsync(IUser, Guid, ISet<string>)

Authorize that a user has access to the descendant items of a content item.

Declaration

Task<ContentAuthorizationStatus> AuthorizeDescendantsAccessAsync(IUser user, Guid parentKey, ISet<string> permissionsToCheck)

Parameters

Type	Name	Description
IUser	user	IUser to authorize.
Guid	parentKey	The identifier of the parent content item to check its descendants for access.
ISet<string>	permissionsToCheck	The collection of permissions to authorize.

Returns

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

View Source

AuthorizeDescendantsAccessAsync(IUser, Guid, string)

Authorize that a user has access to the descendant items of a content item.

Declaration

Task<ContentAuthorizationStatus> AuthorizeDescendantsAccessAsync(IUser user, Guid parentKey, string permissionToCheck)

Parameters

Type	Name	Description
IUser	user	IUser to authorize.
Guid	parentKey	The identifier of the parent content item to check its descendants for access.
string	permissionToCheck	The permission to authorize.

Returns

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

View Source

AuthorizeRootAccessAsync(IUser, ISet<string>)

Authorize that a user is allowed to perform actions on the content root item.

Declaration

Task<ContentAuthorizationStatus> 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<ContentAuthorizationStatus>	A task resolving into a ContentAuthorizationStatus.

View Source

AuthorizeRootAccessAsync(IUser, string)

Authorize that a user is allowed to perform action on the content root item.

Declaration

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

Parameters

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

Returns

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