View Source

Class UserGroup

Represents a Group for a Backoffice User

Inheritance

object

BeingDirtyBase

EntityBase

Namespace: Umbraco.Cms.Core.Models.Membership

Assembly: Umbraco.Core.dll

Syntax

[Serializable]
[DataContract(IsReference = true)]
public class UserGroup : EntityBase, IUserGroup, IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty, IReadOnlyUserGroup

Constructors

UserGroup(IShortStringHelper)

Constructor to create a new user group

Declaration

public UserGroup(IShortStringHelper shortStringHelper)

Parameters

Type	Name	Description
IShortStringHelper	shortStringHelper

UserGroup(IShortStringHelper, int, string?, string?, string?)

Constructor to create an existing user group

Declaration

public UserGroup(IShortStringHelper shortStringHelper, int userCount, string? alias, string? name, string? icon)

Parameters

Type	Name	Description
IShortStringHelper	shortStringHelper
int	userCount
string	alias
string	name
string	icon

Properties

Alias

Declaration

[DataMember]
public string Alias { get; set; }

Property Value

Type	Description
string

AllowedLanguages

Declaration

public IEnumerable<int> AllowedLanguages { get; }

Property Value

Type	Description
IEnumerable<int>

AllowedSections

Declaration

public IEnumerable<string> AllowedSections { get; }

Property Value

Type	Description
IEnumerable<string>

GranularPermissions

Declaration

public ISet<IGranularPermission> GranularPermissions { get; set; }

Property Value

Type	Description
ISet<IGranularPermission>

HasAccessToAllLanguages

If this property is true it will give the group access to all languages

This is set to return true as default to avoid breaking changes

Declaration

[DataMember]
public bool HasAccessToAllLanguages { get; set; }

Property Value

Type	Description
bool

Icon

The icon

Declaration

[DataMember]
public string? Icon { get; set; }

Property Value

Type	Description
string

Name

The name

Declaration

[DataMember]
public string? Name { get; set; }

Property Value

Type	Description
string

Permissions

The set of permissions provided by the frontend.

Declaration

public ISet<string> Permissions { get; set; }

Property Value

Type	Description
ISet<string>

Remarks

By default the server has no concept of what all of these strings mean, we simple store them and return them to the UI.

StartContentId

Declaration

[DataMember]
public int? StartContentId { get; set; }

Property Value

Type	Description
int?

StartMediaId

Declaration

[DataMember]
public int? StartMediaId { get; set; }

Property Value

Type	Description
int?

UserCount

Specifies the number of users assigned to this group

Declaration

public int UserCount { get; }

Property Value

Type	Description
int

Methods

AddAllowedLanguage(int)

Declaration

public void AddAllowedLanguage(int languageId)

Parameters

Type	Name	Description
int	languageId

AddAllowedSection(string)

Declaration

public void AddAllowedSection(string sectionAlias)

Parameters

Type	Name	Description
string	sectionAlias

ClearAllowedLanguages()

Declaration

public void ClearAllowedLanguages()

ClearAllowedSections()

Declaration

public void ClearAllowedSections()

PerformDeepClone(object)

Used by inheritors to modify the DeepCloning logic

Declaration

protected override void PerformDeepClone(object clone)

Parameters

Type	Name	Description
object	clone

RemoveAllowedLanguage(int)

Declaration

public void RemoveAllowedLanguage(int languageId)

Parameters

Type	Name	Description
int	languageId

RemoveAllowedSection(string)

Declaration

public void RemoveAllowedSection(string sectionAlias)

Parameters

Type	Name	Description
string	sectionAlias