Class UserServiceExtensions

Provides extension methods for IUserService.

Inheritance

object

Namespace: Umbraco.Extensions

Assembly: Umbraco.Core.dll

Syntax

public static class UserServiceExtensions

Methods

View Source

GetAllPermissions(IUserService, IUser?, string)

Gets all permissions for a user at the specified path.

Declaration

public static EntityPermissionCollection GetAllPermissions(this IUserService userService, IUser? user, string path)

Parameters

Type	Name	Description
IUserService	userService	The user service.
IUser	user	The user to get permissions for.
string	path	The path to check permissions for.

Returns

Type	Description
EntityPermissionCollection	A collection of EntityPermission for the specified path.

Exceptions

Type	Condition
InvalidOperationException	Thrown when the path cannot be parsed into an array of integers or is empty.

View Source

GetPermissions(IUserService, IUser?, string)

Gets the first permission for a user at the specified path.

Declaration

public static EntityPermission? GetPermissions(this IUserService userService, IUser? user, string path)

Parameters

Type	Name	Description
IUserService	userService	The user service.
IUser	user	The user to get permissions for.
string	path	The path to check permissions for.

Returns

Type	Description
EntityPermission	The first EntityPermission found, or `null` if none exists.

View Source

GetPermissions(IUserService, IUserGroup?, bool, params int[])

Get explicitly assigned permissions for a group and optional node Ids

Declaration

public static EntityPermissionCollection GetPermissions(this IUserService service, IUserGroup? group, bool fallbackToDefaultPermissions, params int[] nodeIds)

Parameters

Type	Name	Description
IUserService	service
IUserGroup	group
bool	fallbackToDefaultPermissions	Flag indicating if we want to include the default group permissions for each result if there are not explicit permissions set
int[]	nodeIds	Specifying nothing will return all permissions for all nodes

Returns

Type	Description
EntityPermissionCollection	An enumerable list of EntityPermission

View Source

GetPermissionsForPath(IUserService, IUserGroup, string, bool)

Gets the permissions for the provided group and path

Declaration

public static EntityPermissionSet GetPermissionsForPath(this IUserService service, IUserGroup group, string path, bool fallbackToDefaultPermissions = false)

Parameters

Type	Name	Description
IUserService	service
IUserGroup	group
string	path	Path to check permissions for
bool	fallbackToDefaultPermissions	Flag indicating if we want to include the default group permissions for each result if there are not explicit permissions set

Returns

Type	Description
EntityPermissionSet

View Source

GetProfilesById(IUserService, params int[])

Gets user profiles by their identifiers.

Declaration

public static IEnumerable<IProfile> GetProfilesById(this IUserService userService, params int[] ids)

Parameters

Type	Name	Description
IUserService	userService	The user service.
int[]	ids	The user identifiers to retrieve profiles for.

Returns

Type	Description
IEnumerable<IProfile>	An enumerable collection of IProfile instances.

View Source

RemoveUserGroupPermissions(IUserService, int)

Remove all permissions for this user group for all nodes

Declaration

public static void RemoveUserGroupPermissions(this IUserService userService, int groupId)

Parameters

Type	Name	Description
IUserService	userService
int	groupId

View Source

RemoveUserGroupPermissions(IUserService, int, params int[])

Remove all permissions for this user group for all nodes specified

Declaration

public static void RemoveUserGroupPermissions(this IUserService userService, int groupId, params int[] entityIds)

Parameters

Type	Name	Description
IUserService	userService
int	groupId
int[]	entityIds