View Source
Class UserGroupBase
Base class for front-end representation of a User Group.
Contains all the properties shared between Save, Update, Representation, etc...
Inheritance
System.Object
Assembly: Umbraco.Cms.Api.Management.dll
Syntax
public class UserGroupBase
Properties
View Source
DocumentRootAccess
If the group should have access to the document root.
This will be ignored if an explicit start node has been specified in DocumentStartNode.
Declaration
public bool DocumentRootAccess { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
DocumentStartNode
The key of the document that should act as root node for the user group
This can be overwritten by a different user group if a user is a member of multiple groups
Declaration
public ReferenceByIdModel DocumentStartNode { get; set; }
Property Value
View Source
Icon
The Icon for the user group
Declaration
public string Icon { get; set; }
Property Value
| Type |
Description |
| System.String |
|
If the group should have access to the media root.
This will be ignored if an explicit start node has been specified in MediaStartNode.
Declaration
public bool MediaRootAccess { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
The Id of the media that should act as root node for the user group
This can be overwritten by a different user group if a user is a member of multiple groups
Declaration
public ReferenceByIdModel MediaStartNode { get; set; }
Property Value
Methods
View Source
IEnumerable<>(String, Languages)
The languages that the user group has access to
Declaration
public required IEnumerable<>(string, Languages)
Parameters
| Type |
Name |
Description |
| System.String |
|
|
| Languages |
|
|
Returns
| Type |
Description |
| required |
|
Type Parameters
View Source
IEnumerable<>(String, Sections)
The sections that the user group has access to
Declaration
public required IEnumerable<>(string, Sections)
Parameters
| Type |
Name |
Description |
| System.String |
|
|
| Sections |
|
|
Returns
| Type |
Description |
| required |
|
Type Parameters
View Source
ISet<>(String, FallbackPermissions)
List of permissions provided, and maintained by the front-end. The server has no concept all of them, but some can be used on the server.
Declaration
public required ISet<>(string, FallbackPermissions)
Parameters
| Type |
Name |
Description |
| System.String |
|
|
| FallbackPermissions |
|
|
Returns
| Type |
Description |
| required |
|
Type Parameters
View Source
ISet<IPermissionPresentationModel>(Permissions)
Declaration
public required ISet<IPermissionPresentationModel>(Permissions)
Parameters
Returns
| Type |
Description |
| required |
|
Type Parameters
| Name |
Description |
| IPermissionPresentationModel |
|