Interface IReadOnlyUserGroup
A readonly user group providing basic information
Namespace: Umbraco.Cms.Core.Models.Membership
Assembly: Umbraco.Core.dll
Syntax
public interface IReadOnlyUserGroupProperties
View SourceAlias
Gets the alias of the user group.
Declaration
string Alias { get; }Property Value
| Type | Description |
|---|---|
| string |
AllowedLanguages
Gets the collection of language identifiers that this user group has access to.
Declaration
IEnumerable<int> AllowedLanguages { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<int> |
AllowedSections
Gets the collection of section aliases that this user group has access to.
Declaration
IEnumerable<string> AllowedSections { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<string> |
Description
Gets the description of the user group.
Declaration
string? Description { get; }Property Value
| Type | Description |
|---|---|
| string |
Remarks
TODO (V18): Remove the default implementations.
GranularPermissions
Gets the set of granular permissions assigned to this user group.
Declaration
ISet<IGranularPermission> GranularPermissions { get; }Property Value
| Type | Description |
|---|---|
| ISet<IGranularPermission> |
HasAccessToAllLanguages
Gets a value indicating whether this user group has access to all languages.
Declaration
bool HasAccessToAllLanguages { get; }Property Value
| Type | Description |
|---|---|
| bool |
Remarks
This is set to return true as default to avoid breaking changes.
Icon
Gets the icon for the user group.
Declaration
string? Icon { get; }Property Value
| Type | Description |
|---|---|
| string |
Id
Gets the unique identifier for the user group.
Declaration
int Id { get; }Property Value
| Type | Description |
|---|---|
| int |
Key
Gets the unique key for the user group.
Declaration
Guid Key { get; }Property Value
| Type | Description |
|---|---|
| Guid |
Name
Gets the name of the user group.
Declaration
string? Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Permissions
Gets the set of permissions assigned to this user group.
Declaration
ISet<string> Permissions { get; }Property Value
| Type | Description |
|---|---|
| ISet<string> |
StartContentId
Gets the starting content node identifier for this user group.
Declaration
int? StartContentId { get; }Property Value
| Type | Description |
|---|---|
| int? |
StartMediaId
Gets the starting media node identifier for this user group.
Declaration
int? StartMediaId { get; }Property Value
| Type | Description |
|---|---|
| int? |
Methods
View SourceHasAccessToLanguage(int)
Determines whether this user group has access to the specified language.
Declaration
bool HasAccessToLanguage(int languageId)Parameters
| Type | Name | Description |
|---|---|---|
| int | languageId | The language identifier to check. |
Returns
| Type | Description |
|---|---|
| bool |
|