View Source
Class UserGroup
Represents a Group for a Backoffice User
Inheritance
System.Object
Assembly: Umbraco.Core.dll
Syntax
[DataContract(IsReference = true)]
public class UserGroup : EntityBase, IUserGroup, IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty, IReadOnlyUserGroup
Constructors
View Source
UserGroup(IShortStringHelper)
Constructor to create a new user group
Declaration
public UserGroup(IShortStringHelper shortStringHelper)
Parameters
View Source
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
View Source
Alias
Declaration
[DataMember]
public string Alias { get; set; }
Property Value
Type |
Description |
System.String |
|
View Source
AllowedLanguages
Declaration
public IEnumerable<int> AllowedLanguages { get; }
Property Value
Type |
Description |
IEnumerable<System.Int32> |
|
View Source
AllowedSections
Declaration
public IEnumerable<string> AllowedSections { get; }
Property Value
Type |
Description |
IEnumerable<System.String> |
|
View Source
HasAccessToAllLanguages
Declaration
[DataMember]
public bool HasAccessToAllLanguages { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
View Source
Icon
Declaration
[DataMember]
public string Icon { get; set; }
Property Value
Type |
Description |
System.String |
|
View Source
Name
Declaration
[DataMember]
public string Name { get; set; }
Property Value
Type |
Description |
System.String |
|
View Source
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>> |
|
View Source
StartContentId
Declaration
[DataMember]
public int? StartContentId { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Int32> |
|
View Source
Declaration
[DataMember]
public int? StartMediaId { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Int32> |
|
View Source
UserCount
Declaration
public int UserCount { get; }
Property Value
Type |
Description |
System.Int32 |
|
Methods
View Source
AddAllowedLanguage(Int32)
Declaration
public void AddAllowedLanguage(int languageId)
Parameters
Type |
Name |
Description |
System.Int32 |
languageId |
|
View Source
AddAllowedSection(String)
Declaration
public void AddAllowedSection(string sectionAlias)
Parameters
Type |
Name |
Description |
System.String |
sectionAlias |
|
View Source
ClearAllowedLanguages()
Declaration
public void ClearAllowedLanguages()
View Source
ClearAllowedSections()
Declaration
public void ClearAllowedSections()
View Source
Declaration
protected override void PerformDeepClone(object clone)
Parameters
Type |
Name |
Description |
System.Object |
clone |
|
View Source
RemoveAllowedLanguage(Int32)
Declaration
public void RemoveAllowedLanguage(int languageId)
Parameters
Type |
Name |
Description |
System.Int32 |
languageId |
|
View Source
RemoveAllowedSection(String)
Declaration
public void RemoveAllowedSection(string sectionAlias)
Parameters
Type |
Name |
Description |
System.String |
sectionAlias |
|