Class default

The RoleManager class is responsible for managing the roles of the current main identity.

Constructors

constructor

new default(leuteModel, roles): default
Constructor for the RoleManager class.
Parameters
- leuteModel: default
  The LeuteModel instance.
- roles: default[]
  The roles to be managed.
Returns default
- Defined in models/role/RoleManager.ts:33

Properties

onCurrentPersonRoleChange

onCurrentPersonRoleChange: OEvent<((roles: Role[]) => void)>

onRoleFound

onRoleFound: OEvent<(() => void)>

Methods

getAllRoleNames

getAllRoleNames(): string[]
Returns the role names that are available.

Returns string[]
The role names that are available.
- Defined in models/role/RoleManager.ts:206

getAllRoles

getAllRoles(): default[]
Returns the roles that are available.

Returns default[]
The roles that are available.
- Defined in models/role/RoleManager.ts:180

getCreatableRoles

getCreatableRoles(): default[]
Returns the roles that can be created.

Returns default[]
The roles that can be created.
- Defined in models/role/RoleManager.ts:214

getCurrentPersonCreatableRoles

getCurrentPersonCreatableRoles(): Role[]
Returns the creatable roles for the current main identity.

Returns Role[]
The creatable roles for the current main identity.
- Defined in models/role/RoleManager.ts:138

getCurrentPersonRoleNames

getCurrentPersonRoleNames(): string[]
Returns the role names that are currently available for the current main identity.

Returns string[]
The role names that are currently available for the current main identity.
- Defined in models/role/RoleManager.ts:127

getCurrentPersonRoles

getCurrentPersonRoles(): undefined | Role[]
Returns
- The roles that are currently available for the current main identity.
- Undefined if the roles are not initialised yet.
Returns undefined | Role[]
- Defined in models/role/RoleManager.ts:116

getPersonCreatableRoles

getPersonCreatableRoles(person): Promise<default[]>
Returns the roles that can be created for the given person.
Parameters
- person: SHA256IdHash<Person>
  The person to check.
Returns Promise<default[]>
The roles that can be created for the given person.
- Defined in models/role/RoleManager.ts:237

getPersonRoleNames

getPersonRoleNames(person): Promise<string[]>
Returns the role names that are available for the given person.
Parameters
- person: SHA256IdHash<Person>
  The person to check.
Returns Promise<string[]>
The role names that are available for the given person.
- Defined in models/role/RoleManager.ts:280

getPersonRoles

getPersonRoles(person): Promise<Role[]>
Returns the roles that are available for the given person.
Parameters
- person: SHA256IdHash<Person>
  The person to check.
Returns Promise<Role[]>
The roles that are available for the given person.
- Defined in models/role/RoleManager.ts:271

getRole

getRole<T>(role): undefined | T
Returns the role that is available.
Type Parameters
- T extends default
Parameters
- role: string
  The role to get.
Returns undefined | T
The role that is available.
- Defined in models/role/RoleManager.ts:189

getRoles

getRoles(roles): default[]
Returns the roles that are available.
Parameters
- roles: string[]
  The roles to get.
Returns default[]
The roles that are available.
- Defined in models/role/RoleManager.ts:198

init

init(): Promise<void>
Initializes the role manager.

Returns Promise<void>
A promise that resolves when the role manager is initialised.
- Defined in models/role/RoleManager.ts:55

isCreatableRole

isCreatableRole(role): boolean
Returns true if the given role can be created.
Parameters
- role: string | Role | (string | Role)[]
  The role to check.
Returns boolean
True if the given role can be created, false otherwise.
- Defined in models/role/RoleManager.ts:223

isCurrentPersonCreatableRole

isCurrentPersonCreatableRole(role): boolean
Returns true if the current main identity can create the given role.
Parameters
- role: string | Role | (string | Role)[]
  The role to check.
Returns boolean
True if the current main identity can create the given role, false otherwise.
- Defined in models/role/RoleManager.ts:163

isCurrentPersonRole

isCurrentPersonRole(role): boolean
Returns true if the current main identity has the role.
Parameters
- role: string | Role | (string | Role)[]
  The role, role name or array of those to check.
Returns boolean
True if the current main identity has the role, false otherwise.
- Defined in models/role/RoleManager.ts:96

isPersonCreatableRole

isPersonCreatableRole(person, role): Promise<boolean>
Returns true if the given person can create the given role.
Parameters
- person: SHA256IdHash<Person>
  The person to check.
- role: string | Role | (string | Role)[]
  The role to check.
Returns Promise<boolean>
True if the given person can create the given role, false otherwise.
- Defined in models/role/RoleManager.ts:253

isPersonRole

isPersonRole(person, role): Promise<boolean>
Returns true if the given person has the given role.
Parameters
- person: SHA256IdHash<Person>
  The person to check.
- role: string | Role | (string | Role)[]
  The role to check.
Returns Promise<boolean>
True if the given person has the given role, false otherwise.
- Defined in models/role/RoleManager.ts:290

shutdown

shutdown(): Promise<void>
Shuts down the role manager.

Returns Promise<void>
- Defined in models/role/RoleManager.ts:84