View Source

Interface IUserGroup

Namespace: Umbraco.Cms.Core.Models.Membership
Assembly: Umbraco.Core.dll
Syntax
public interface IUserGroup : IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty

Properties

View Source

Alias

Declaration
string Alias { get; set; }
Property Value
Type Description
string
View Source

AllowedLanguages

Declaration
IEnumerable<int> AllowedLanguages { get; }
Property Value
Type Description
IEnumerable<int>
View Source

AllowedSections

Declaration
IEnumerable<string> AllowedSections { get; }
Property Value
Type Description
IEnumerable<string>
View Source

GranularPermissions

Declaration
ISet<IGranularPermission> GranularPermissions { get; set; }
Property Value
Type Description
ISet<IGranularPermission>
View Source

HasAccessToAllLanguages

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

Declaration
bool HasAccessToAllLanguages { get; set; }
Property Value
Type Description
bool
View Source

Icon

The icon

Declaration
string? Icon { get; set; }
Property Value
Type Description
string
View Source

Name

The name

Declaration
string? Name { get; set; }
Property Value
Type Description
string
View Source

Permissions

The set of permissions provided by the frontend.

Declaration
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.

View Source

StartContentId

Declaration
int? StartContentId { get; set; }
Property Value
Type Description
int?
View Source

StartMediaId

Declaration
int? StartMediaId { get; set; }
Property Value
Type Description
int?
View Source

UserCount

Specifies the number of users assigned to this group

Declaration
int UserCount { get; }
Property Value
Type Description
int

Methods

View Source

AddAllowedLanguage(int)

Declaration
void AddAllowedLanguage(int languageId)
Parameters
Type Name Description
int languageId
View Source

AddAllowedSection(string)

Declaration
void AddAllowedSection(string sectionAlias)
Parameters
Type Name Description
string sectionAlias
View Source

ClearAllowedLanguages()

Declaration
void ClearAllowedLanguages()
View Source

ClearAllowedSections()

Declaration
void ClearAllowedSections()
View Source

RemoveAllowedLanguage(int)

Declaration
void RemoveAllowedLanguage(int languageId)
Parameters
Type Name Description
int languageId
View Source

RemoveAllowedSection(string)

Declaration
void RemoveAllowedSection(string sectionAlias)
Parameters
Type Name Description
string sectionAlias