View Source

Class ReadOnlyUserGroup

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.Models.Membership

Assembly: Umbraco.Core.dll

Syntax

public class ReadOnlyUserGroup : IReadOnlyUserGroup

Constructors

ReadOnlyUserGroup(Int32, Guid, String, String, Nullable<Int32>, Nullable<Int32>, String, IEnumerable<Int32>, IEnumerable<String>, Nullable<IEnumerable<String>>, Boolean)

Declaration

public ReadOnlyUserGroup(int id, Guid key, string name, string icon, int? startContentId, int? startMediaId, string alias, IEnumerable<int> allowedLanguages, IEnumerable<string> allowedSections, IEnumerable<string>? permissions, bool hasAccessToAllLanguages)

Parameters

Type	Name	Description
System.Int32	id
Guid	key
System.String	name
System.String	icon
System.Nullable<System.Int32>	startContentId
System.Nullable<System.Int32>	startMediaId
System.String	alias
IEnumerable<System.Int32>	allowedLanguages
IEnumerable<System.String>	allowedSections
System.Nullable<IEnumerable<System.String>>	permissions
System.Boolean	hasAccessToAllLanguages

ReadOnlyUserGroup(Int32, String, String, Nullable<Int32>, Nullable<Int32>, String, IEnumerable<Int32>, IEnumerable<String>, Nullable<IEnumerable<String>>, Boolean)

Declaration

public ReadOnlyUserGroup(int id, string name, string icon, int? startContentId, int? startMediaId, string alias, IEnumerable<int> allowedLanguages, IEnumerable<string> allowedSections, IEnumerable<string>? permissions, bool hasAccessToAllLanguages)

Parameters

Type	Name	Description
System.Int32	id
System.String	name
System.String	icon
System.Nullable<System.Int32>	startContentId
System.Nullable<System.Int32>	startMediaId
System.String	alias
IEnumerable<System.Int32>	allowedLanguages
IEnumerable<System.String>	allowedSections
System.Nullable<IEnumerable<System.String>>	permissions
System.Boolean	hasAccessToAllLanguages

ReadOnlyUserGroup(Int32, String, String, Nullable<Int32>, Nullable<Int32>, String, IEnumerable<String>, Nullable<IEnumerable<String>>)

Declaration

public ReadOnlyUserGroup(int id, string name, string icon, int? startContentId, int? startMediaId, string alias, IEnumerable<string> allowedSections, IEnumerable<string>? permissions)

Parameters

Type	Name	Description
System.Int32	id
System.String	name
System.String	icon
System.Nullable<System.Int32>	startContentId
System.Nullable<System.Int32>	startMediaId
System.String	alias
IEnumerable<System.String>	allowedSections
System.Nullable<IEnumerable<System.String>>	permissions

Properties

Alias

Declaration

public string Alias { get; }

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

public bool HasAccessToAllLanguages { get; set; }

Property Value

Type	Description
System.Boolean

Icon

Declaration

public string Icon { get; }

Property Value

Type	Description
System.String

Id

Declaration

public int Id { get; }

Property Value

Type	Description
System.Int32

Name

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Permissions

The set of default permissions

Declaration

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

public int? StartContentId { get; }

Property Value

Type	Description
System.Nullable<System.Int32>

StartMediaId

Declaration

public int? StartMediaId { get; }

Property Value

Type	Description
System.Nullable<System.Int32>

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Equals(ReadOnlyUserGroup)

Declaration

public bool Equals(ReadOnlyUserGroup other)

Parameters

Type	Name	Description
ReadOnlyUserGroup	other

Returns

Type	Description
System.Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Operators

Equality(ReadOnlyUserGroup, ReadOnlyUserGroup)

Declaration

public static bool operator ==(ReadOnlyUserGroup left, ReadOnlyUserGroup right)

Parameters

Type	Name	Description
ReadOnlyUserGroup	left
ReadOnlyUserGroup	right

Returns

Type	Description
System.Boolean

Inequality(ReadOnlyUserGroup, ReadOnlyUserGroup)

Declaration

public static bool operator !=(ReadOnlyUserGroup left, ReadOnlyUserGroup right)

Parameters

Type	Name	Description
ReadOnlyUserGroup	left
ReadOnlyUserGroup	right

Returns

Type	Description
System.Boolean