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
System.String

View Source

AllowedLanguages

Declaration

virtual IEnumerable<int> AllowedLanguages { get; }

Property Value

Type	Description
IEnumerable<System.Int32>

View Source

AllowedSections

Declaration

IEnumerable<string> AllowedSections { get; }

Property Value

Type	Description
IEnumerable<System.String>

View Source

HasAccessToAllLanguages

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

Declaration

virtual bool HasAccessToAllLanguages { get; }

Property Value

Type	Description
System.Boolean

View Source

Icon

The icon

Declaration

string Icon { get; set; }

Property Value

Type	Description
System.String

View Source

Name

The name

Declaration

string Name { get; set; }

Property Value

Type	Description
System.String

View Source

Permissions

The set of default permissions

Declaration

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.

View Source

StartContentId

Declaration

int? StartContentId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

View Source

StartMediaId

Declaration

int? StartMediaId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

View Source

UserCount

Specifies the number of users assigned to this group

Declaration

int UserCount { get; }

Property Value

Type	Description
System.Int32

Methods

View Source

AddAllowedLanguage(Int32)

Declaration

virtual void AddAllowedLanguage(int languageId)

Parameters

Type	Name	Description
System.Int32	languageId

View Source

AddAllowedSection(String)

Declaration

void AddAllowedSection(string sectionAlias)

Parameters

Type	Name	Description
System.String	sectionAlias

View Source

ClearAllowedLanguages()

Declaration

virtual void ClearAllowedLanguages()

View Source

ClearAllowedSections()

Declaration

void ClearAllowedSections()

View Source

RemoveAllowedLanguage(Int32)

Declaration

virtual void RemoveAllowedLanguage(int languageId)

Parameters

Type	Name	Description
System.Int32	languageId

View Source

RemoveAllowedSection(String)

Declaration

void RemoveAllowedSection(string sectionAlias)

Parameters

Type	Name	Description
System.String	sectionAlias