Interface IRole

The system entity for a role

See https://help.lemonedge.com/help/open-architecture/admin/roles/intro.html for more information

Inherited Members
Namespace: LemonEdge.API.Entities.Administration
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.Roles, "dbo.LT_Roles", "Role", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "help/open-architecture/admin/roles/intro.html")]
[DefaultEntityIcon(ImageType.Role)]
public interface IRole : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier

Properties

CacheType

Indicates the default loading of the cache into the client. Can be configured for fast external access users such as those looking at dashboards from a browser

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates the default loading of the cache into the client. Can be configured for fast external access users such as those looking at dashboards from a browser.")]
CacheLoad CacheType { get; set; }
Property Value
Type Description
CacheLoad

Description

A user friendly description of the purpose for this role

Declaration
[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("A user friendly description of this roles function.")]
string Description { get; set; }
Property Value
Type Description
string

IsSystem

Indicates this is one of the two system provided roles - Admin and Standard User.

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this is a role maintained by the system, and will automatically be modified on upgrades. You can not edit this role.")]
bool IsSystem { get; set; }
Property Value
Type Description
bool

Name

[Key] A unique user friendly name for this role.

Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this role.")]
[Unique]
[Required]
string Name { get; set; }
Property Value
Type Description
string

RoleHelpURL

If you have created a custom role with specific functionality, you can provide a help url to ensure users can get access to a help guide through how to use the role.

Declaration
[EntityProperty(SQLType.NVarChar, 2500, true)]
[EntityDescription("Holds the help url for this role. Defaults to the base help url if empty.")]
string RoleHelpURL { get; set; }
Property Value
Type Description
string

Extension Methods