Class default

constructor

• new default(leuteModel: default, roles: default[]): default

  Constructor for the RoleManager class.

  Parameters

  • leuteModel: default

    The LeuteModel instance.
  • roles: default[]

    The roles to be managed.

  Returns default

onCurrentPersonRoleChange

onRoleFound

getAllRoleNames

• getAllRoleNames(): string[]

  Returns the role names that are available.

  Returns string[]

  The role names that are available.

getAllRoles

• getAllRoles(): default[]

  Returns the roles that are available.

  Returns default[]

  The roles that are available.

getCreatableRoles

• getCreatableRoles(): default[]

  Returns the roles that can be created.

  Returns default[]

  The roles that can be created.

getCurrentPersonCreatableRoles

• getCurrentPersonCreatableRoles(): default[]

  Returns the creatable roles for the current main identity.

  Returns default[]

  The creatable roles for the current main identity.

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.

getCurrentPersonRoles

• getCurrentPersonRoles(): undefined | default[]

  Returns

  • The roles that are currently available for the current main identity.
  • Undefined if the roles are not initialised yet.

  Returns undefined | default[]

getPersonCreatableRoles

• getPersonCreatableRoles(person: SHA256IdHash<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.

getPersonRoleNames

• getPersonRoleNames(person: SHA256IdHash<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.

getPersonRoles

• getPersonRoles(person: SHA256IdHash<Person>): Promise<default[]>

  Returns the roles that are available for the given person.

  Parameters

  • person: SHA256IdHash<Person>

    The person to check.

  Returns Promise<default[]>

  The roles that are available for the given person.

getRole

• getRole<T extends default>(role: string | StaticRoleModel<T>): undefined | T

  Returns the role that is available.

  Type Parameters

  • T extends default

  Parameters

  • role: string | StaticRoleModel<T>

    The role name or class constructor to get.

  Returns undefined | T

  The role that is available.

getRoles

• getRoles(roles: string[]): default[]

  Returns the roles that are available.

  Parameters

  • roles: string[]

    The roles to get.

  Returns default[]

  The roles that are available.

init

• init(): Promise<void>

  Initializes the role manager.

  Returns Promise<void>

  A promise that resolves when the role manager is initialised.

isCreatableRole

• isCreatableRole(role: string | default | (string | default)[]): boolean

  Returns true if the given role can be created.

  Parameters

  • role: string | default | (string | default)[]

    The role to check.

  Returns boolean

  True if the given role can be created, false otherwise.

isCurrentPersonCreatableRole

• isCurrentPersonCreatableRole(
      role: string | default | (string | default)[],
  ): boolean

  Returns true if the current main identity can create the given role.

  Parameters

  • role: string | default | (string | default)[]

    The role to check.

  Returns boolean

  True if the current main identity can create the given role, false otherwise.

isCurrentPersonRole

• isCurrentPersonRole(role: string | default | (string | default)[]): boolean

  Returns true if the current main identity has the role.

  Parameters

  • role: string | default | (string | default)[]

    The role, role name or array of those to check.

  Returns boolean

  True if the current main identity has the role, false otherwise.

isPersonCreatableRole

• isPersonCreatableRole(
      person: SHA256IdHash<Person>,
      role: string | default | (string | default)[],
  ): Promise<boolean>

  Returns true if the given person can create the given role.

  Parameters

  • person: SHA256IdHash<Person>

    The person to check.
  • role: string | default | (string | default)[]

    The role to check.

  Returns Promise<boolean>

  True if the given person can create the given role, false otherwise.

isPersonRole

• isPersonRole(
      person: SHA256IdHash<Person>,
      role: string | default | (string | default)[],
  ): Promise<boolean>

  Returns true if the given person has the given role.

  Parameters

  • person: SHA256IdHash<Person>

    The person to check.
  • role: string | default | (string | default)[]

    The role to check.

  Returns Promise<boolean>

  True if the given person has the given role, false otherwise.

shutdown

• shutdown(): Promise<void>

  Shuts down the role manager.

  Returns Promise<void>