Show / Hide Table of Contents

Class Module

Represents a module in the permission system. A module groups one or more functionality and it is also possible to restrict a tenants access to functionality by configuring BoughtModule.

Inheritance
Object
Module
Inherited Members
Object.Equals(Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: IRM.AspNetCore.Identity
Assembly: IRM.AspNetCore.Identity.dll
Syntax
public class Module

Constructors

Module()

Creates a new instance of Module.

Declaration
public Module()

Module(Guid)

Creates a new instance of Module with a specified id.

Declaration
public Module(Guid id)
Parameters
System.Guid id

The unique identity of this module.

Fields

SäkerhetModuleName

The name of the build-in module 'Säkerhet'.

Declaration
public const string SäkerhetModuleName = "Säkerhet"
Field Value
String

Properties

Functionalities

Gets a collection of Functionality that belongs to this module.

Declaration
public List<Functionality> Functionalities { get; }
Property Value
List<Functionality>

Id

Gets the identity of the module.

Declaration
public Guid Id { get; }
Property Value
System.Guid

Name

Gets or sets the name of the module.

Declaration
public string Name { get; set; }
Property Value
String

Online

Gets or sets if the module is online or not.

Declaration
public bool Online { get; set; }
Property Value
Boolean

RoleTemplates

Gets a collection of RoleTemplate that belongs to this module.

Declaration
public List<RoleTemplate> RoleTemplates { get; }
Property Value
List<RoleTemplate>

Uri

Gets or sets the default base url for the module.

Declaration
public string Uri { get; set; }
Property Value
String

Methods

Buy(Guid)

Buys a module for a tenant.

Declaration
public virtual BoughtModule Buy(Guid tenantId)
Parameters
System.Guid tenantId

The identity of the tenant that buys the module.

Returns
BoughtModule

The BoughtModule representing the bought module.

UpdateFunctionality(Guid, String, String, FunctionalityAudience, Boolean)

Updates the functionality with the supplied values.

Declaration
public virtual Functionality UpdateFunctionality(Guid id, string name, string description, FunctionalityAudience targetAudience, bool requireTenantPermission)
Parameters
System.Guid id

The unique identifier of the functionality.

String name

The name of the functionality.

String description

The description of the functionality.

FunctionalityAudience targetAudience

The FunctionalityAudience of the functionality.

Boolean requireTenantPermission

true if tenant permission is required for the functionality; otherwise false.

Returns
Functionality

The updated functionality.

Extension Methods

IRM.AspNetCore.Identity.EntityFrameworkCore.FunctionalityDbContextExtensions.AddSecurityFunctionality(IRM.AspNetCore.Identity.Module, IRM.AspNetCore.Identity.PriceLevel, System.Nullable<System.Guid>, System.Nullable<System.Boolean>)
IRM.AspNetCore.Identity.EntityFrameworkCore.FunctionalityDbContextExtensions.AddSecurityRoleTemplate(IRM.AspNetCore.Identity.Module, System.Boolean)
Back to top Generated by DocFX