Class RoleCache
Cache that holds information about role MDO list. Includes deleted items.
Inherited Members
Namespace: SuperOffice.CRM.Cache
Assembly: SoDataBase.dll
Syntax
[CacheV2(0)]
public class RoleCache : CacheBaseV2
Constructors
RoleCache()
Cache that holds information about role MDO list. Includes deleted items.
Declaration
public RoleCache()
Properties
TableNames
Gets the names of the table data that are cached in this cache. When these tables are updated the cache will be disposed so a new cache instance can take its place.
Declaration
protected override IEnumerable<string> TableNames { get; }
Property Value
| Type | Description |
|---|---|
| IEnumerable<string> |
Overrides
Methods
GetAllRoles(bool)
Return all Role records in cache
Declaration
public RoleRecordData[] GetAllRoles(bool inclDeleted)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | inclDeleted | Do we include deleted records or not? |
Returns
| Type | Description |
|---|---|
| RoleRecordData[] | Array of Role record with id, value, tooltip. |
GetNameFromId(int)
Return a Role list name by id.
Declaration
public string GetNameFromId(int id)
Parameters
| Type | Name | Description |
|---|---|---|
| int | id | 123 |
Returns
| Type | Description |
|---|---|
| string | Role name or "" if no match. Item may be marked deleted. |
GetRoleFromId(int)
Return a Role list item by id.
Declaration
public RoleRecordData GetRoleFromId(int id)
Parameters
| Type | Name | Description |
|---|---|---|
| int | id | 123 |
Returns
| Type | Description |
|---|---|
| RoleRecordData | Role record or NULL if no match. Record may be marked deleted. |
GetRoleFromName(string)
Return a Role based on a name. Returns first case insensitive match.
Declaration
public RoleRecordData GetRoleFromName(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | "Admin" |
Returns
| Type | Description |
|---|---|
| RoleRecordData | Role record with id, value, tooltip. NULL if no match found |
OnLoad()
Actual cache loading method, to be implemented by derived class. Sentry is Ignored when this method is called
Declaration
protected override void OnLoad()
Overrides
OnLoadAsync(CancellationToken)
Actual cache loading method, to be implemented by derived class. Sentry is Ignored when this method is called
Declaration
[CreateSyncVersion(OmitNullableDirective = true)]
protected override Task OnLoadAsync(CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task |