Interface IContentPermissionService
Manages permissions for content access.
Namespace: Umbraco.Cms.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public interface IContentPermissionServiceMethods
View SourceAuthorizeAccessAsync(IUser, Guid, String)
Authorize that a user has access to a content item.
Declaration
virtual 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. |
| System. |
permissionToCheck | The permission to authorize. |
Returns
| Type | Description |
|---|---|
| Task<Content |
A task resolving into a Content |
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<System. |
permissionsToCheck | The collection of permissions to authorize. |
Returns
| Type | Description |
|---|---|
| Task<Content |
A task resolving into a Content |
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<System. |
permissionsToCheck | The collection of permissions to authorize. |
Returns
| Type | Description |
|---|---|
| Task<Content |
A task resolving into a Content |
AuthorizeBinAccessAsync(IUser, String)
Authorize that a user is allowed to perform action on the content bin item.
Declaration
virtual Task<ContentAuthorizationStatus> AuthorizeBinAccessAsync(IUser user, string permissionToCheck)Parameters
| Type | Name | Description |
|---|---|---|
| IUser | user | IUser to authorize. |
| System. |
permissionToCheck | The permission to authorize. |
Returns
| Type | Description |
|---|---|
| Task<Content |
A task resolving into a Content |
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<System. |
culturesToCheck | The collection of cultures to authorize. |
Returns
| Type | Description |
|---|---|
| Task<Content |
A task resolving into a Content |
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<System. |
permissionsToCheck | The collection of permissions to authorize. |
Returns
| Type | Description |
|---|---|
| Task<Content |
A task resolving into a Content |
AuthorizeDescendantsAccessAsync(IUser, Guid, String)
Authorize that a user has access to the descendant items of a content item.
Declaration
virtual 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. |
| System. |
permissionToCheck | The permission to authorize. |
Returns
| Type | Description |
|---|---|
| Task<Content |
A task resolving into a Content |
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<System. |
permissionsToCheck | The collection of permissions to authorize. |
Returns
| Type | Description |
|---|---|
| Task<Content |
A task resolving into a Content |
AuthorizeRootAccessAsync(IUser, String)
Authorize that a user is allowed to perform action on the content root item.
Declaration
virtual Task<ContentAuthorizationStatus> AuthorizeRootAccessAsync(IUser user, string permissionToCheck)Parameters
| Type | Name | Description |
|---|---|---|
| IUser | user | IUser to authorize. |
| System. |
permissionToCheck | The permission to authorize. |
Returns
| Type | Description |
|---|---|
| Task<Content |
A task resolving into a Content |