View Source

Class UserGroup

Represents a Group for a Backoffice User

Inheritance

System.Object

BeingDirtyBase

EntityBase

Namespace: Umbraco.Cms.Core.Models.Membership

Assembly: Umbraco.Core.dll

Syntax

[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, Int32, String, String, IEnumerable<String>, String)

Constructor to create an existing user group

Declaration

public UserGroup(IShortStringHelper shortStringHelper, int userCount, string alias, string name, IEnumerable<string> permissions, string icon)

Parameters

Type	Name	Description
IShortStringHelper	shortStringHelper
System.Int32	userCount
System.String	alias
System.String	name
IEnumerable<System.String>	permissions
System.String	icon

Properties

Alias

Declaration

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

Property Value

Type	Description
System.String

AllowedLanguages

Declaration

public IEnumerable<int> AllowedLanguages { get; }

Property Value

Type	Description
IEnumerable<System.Int32>

AllowedSections

Declaration

public IEnumerable<string> AllowedSections { get; }

Property Value

Type	Description
IEnumerable<System.String>

HasAccessToAllLanguages

Declaration

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

Property Value

Type	Description
System.Boolean

Icon

Declaration

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

Property Value

Type	Description
System.String

Name

Declaration

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

Property Value

Type	Description
System.String

Permissions

The set of default permissions for the user group

Declaration

[DataMember]
public IEnumerable<string>? Permissions { get; set; }

Property Value

Type	Description
System.Nullable<IEnumerable<System.String>>

Remarks

By default each permission is simply a single char but we've made this an enumerable{string} to support a more flexible permissions structure in the future.

StartContentId

Declaration

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

Property Value

Type	Description
System.Nullable<System.Int32>

StartMediaId

Declaration

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

Property Value

Type	Description
System.Nullable<System.Int32>

UserCount

Declaration

public int UserCount { get; }

Property Value

Type	Description
System.Int32

Methods

AddAllowedLanguage(Int32)

Declaration

public void AddAllowedLanguage(int languageId)

Parameters

Type	Name	Description
System.Int32	languageId

AddAllowedSection(String)

Declaration

public void AddAllowedSection(string sectionAlias)

Parameters

Type	Name	Description
System.String	sectionAlias

ClearAllowedLanguages()

Declaration

public void ClearAllowedLanguages()

ClearAllowedSections()

Declaration

public void ClearAllowedSections()

PerformDeepClone(Object)

Declaration

protected override void PerformDeepClone(object clone)

Parameters

Type	Name	Description
System.Object	clone

RemoveAllowedLanguage(Int32)

Declaration

public void RemoveAllowedLanguage(int languageId)

Parameters

Type	Name	Description
System.Int32	languageId

RemoveAllowedSection(String)

Declaration

public void RemoveAllowedSection(string sectionAlias)

Parameters

Type	Name	Description
System.String	sectionAlias