Class Functionality

Represents a functionality in a Module.

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

Constructors

Functionality()

Creates a new instance of Functionality.

Declaration
public Functionality()

Properties

Description

Gets or sets the description of the functionality.

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

Id

Gets the identity of the functionality.

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

ModuleId

Gets or sets the identity of the module that this functionality belongs too.

Declaration
public Guid ModuleId { get; set; }
Property Value
System.Guid

Name

Gets or sets the name of the functionality.

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

Permission

Gets or sets the permission of the functionality. This is the value that is used for the perm claim.

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

RequireTenantPermission

Gets or sets if a tenant must be configured to be allowed to use this functionality.

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

RequireTenantPermissionTurnedOn

Gets or sets if RequireTenantPermission was set to true during this operation.

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

TargetAudience

Gets or sets the FunctionalityAudience for this functionality.

Declaration
public FunctionalityAudience TargetAudience { get; set; }
Property Value
FunctionalityAudience

TenantPermissions

Gets a collection of tenants that are allowed to use this functionality.

Declaration
public List<TenantPermission> TenantPermissions { get; }
Property Value
List<TenantPermission>

Remarks

This should only be used if RequireTenantPermission is true.

Methods

AddTenantPermission(Guid)

Adds a tenant permission for the specified tenantId.

Declaration
public void AddTenantPermission(Guid tenantId)
Parameters
System.Guid tenantId

The tenant to allow access to this functionality.

IsAllowed(Guid)

Gets if the specified tenantId is allowed to use this functionality.

Declaration
public bool IsAllowed(Guid tenantId)
Parameters
System.Guid tenantId

The identity of the tenant.
Returns
Boolean

true if the tenant is allowed to use this functionality; otherwise false.

RemoveTenantPermission(Guid)

Removes a tenant permission for the specified tenantId.

Declaration
public void RemoveTenantPermission(Guid tenantId)
Parameters
System.Guid tenantId

The tenant to remove access from this functionality for.