Search Results for

    Show / Hide Table of Contents
    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
    Namespace: Umbraco.Cms.Api.Management.ViewModels.UserGroup
    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
    View Source

    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
    Type Description
    ReferenceByIdModel
    View Source

    Icon

    The Icon for the user group

    Declaration
    public string Icon { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    MediaRootAccess

    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
    View Source

    MediaStartNode

    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
    Type Description
    ReferenceByIdModel

    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
    Name Description
    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
    Name Description
    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
    Name Description
    View Source

    ISet<IPermissionPresentationModel>(Permissions)

    Declaration
    public required ISet<IPermissionPresentationModel>(Permissions)
    Parameters
    Type Name Description
    Umbraco.Cms.Api.Management.ViewModels.UserGroup.Permissions
    Returns
    Type Description
    required
    Type Parameters
    Name Description
    IPermissionPresentationModel
    • Improve this Doc
    • View Source
    In This Article
    • Properties
      • DocumentRootAccess
      • DocumentStartNode
      • Icon
      • MediaRootAccess
      • MediaStartNode
    • Methods
      • IEnumerable<>(String, Languages)
      • IEnumerable<>(String, Sections)
      • ISet<>(String, FallbackPermissions)
      • ISet<IPermissionPresentationModel>(Permissions)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX