Class default`Abstract`

A model that represents an affirmed role.

Note: Depends on the reverse maps of the LeuteModel to be able to find the someone from the personId and objectEvents to listen for new instances/signatures.

Hierarchy (view full)

default
- default

Implements

Role

Index

Constructors

Properties

Methods

canCreate getCertificateHash getPersonIdFromRoleCertificate getRoleName getRolePersonIds hasAffirmed hasCertificate hasSigned init isRolePerson setRolePerson shutdown

Constructors

constructor

new default(roleName, leuteModel, config?): default
Constructor for the CertificateRoleModel.
Parameters
- roleName: string
  The name of the role.
- leuteModel: default
  The leute model.
- config: Partial<Config> = {}
Returns default
Overrides default.constructor
- Defined in models/role/CertificateRoleModel.ts:61

Properties

onFound

onFound: OEvent<(() => void | Promise<void>)> = ...

Methods

`Abstract`canCreate

canCreate(roleName): boolean | Promise<boolean>
************* Abstracts **************
Parameters
- roleName: string
Returns boolean | Promise<boolean>
Implementation of Role.canCreate
Overrides default.canCreate
- Defined in models/role/CertificateRoleModel.ts:39

`Abstract`getCertificateHash

getCertificateHash(personId): Promise<undefined | SHA256Hash>
Parameters
- personId: SHA256IdHash<Person>
Returns Promise<undefined | SHA256Hash>
- Defined in models/role/CertificateRoleModel.ts:41

`Abstract`getPersonIdFromRoleCertificate

getPersonIdFromRoleCertificate(data): Promise<undefined | SHA256IdHash<Person>>
Parameters
- data: OneObjectTypes
Returns Promise<undefined | SHA256IdHash<Person>>
- Defined in models/role/CertificateRoleModel.ts:42

getRoleName

getRoleName(): string
Returns the role name.

Returns string
The role name.
Implementation of Role.getRoleName
Inherited from default.getRoleName
- Defined in models/role/BaseRoleModel.ts:55

getRolePersonIds

getRolePersonIds(): Promise<SHA256IdHash<Person>[]>
Returns the role person ids.

Returns Promise<SHA256IdHash<Person>[]>
The role person ids.
Implementation of Role.getRolePersonIds
Overrides default.getRolePersonIds
- Defined in models/role/CertificateRoleModel.ts:109

hasAffirmed

hasAffirmed(data, byPersonId?): Promise<boolean>
Checks if the data is affirmed by the role person ids.
Parameters
- data: SHA256Hash | SHA256IdHash
  The data to check.
- OptionalbyPersonId: SHA256IdHash<Person>
  The personId that should be trusting the data.
Returns Promise<boolean>
True if the data is affirmed, false otherwise.
Implementation of Role.hasAffirmed
Inherited from default.hasAffirmed
- Defined in models/role/BaseRoleModel.ts:65

`Abstract`hasCertificate

hasCertificate(personId): Promise<boolean>
Parameters
- personId: SHA256IdHash<Person>
Returns Promise<boolean>
- Defined in models/role/CertificateRoleModel.ts:40

hasSigned

hasSigned(data, byPersonId?): Promise<boolean>
Checks if the data is signed by the role person ids.
Parameters
- data: SHA256Hash
  The data to check.
- OptionalbyPersonId: SHA256IdHash<Person>
  The personId that should be signing the data.
Returns Promise<boolean>
True if the data is signed, false otherwise.
Implementation of Role.hasSigned
Inherited from default.hasSigned
- Defined in models/role/BaseRoleModel.ts:94

init

init(): Promise<void>
Initializes the CertificateRoleModel.

Returns Promise<void>
Implementation of Role.init
Overrides default.init
- Defined in models/role/CertificateRoleModel.ts:76

isRolePerson

isRolePerson(personId?): Promise<boolean>
Checks if the person is a role person.
Parameters
- OptionalpersonId: SHA256IdHash<Person>
  The personId to check. Default is the current person.
Returns Promise<boolean>
True if the person is a role person, false otherwise.
Implementation of Role.isRolePerson
Overrides default.isRolePerson
- Defined in models/role/CertificateRoleModel.ts:122

`Abstract`setRolePerson

setRolePerson(personId, creatorId?): Promise<void>
Parameters
- personId: SHA256IdHash<Person>
- OptionalcreatorId: SHA256IdHash<Person>
Returns Promise<void>
Implementation of Role.setRolePerson
Overrides default.setRolePerson
- Defined in models/role/CertificateRoleModel.ts:45

shutdown

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

Returns Promise<void>
Implementation of Role.shutdown
Overrides default.shutdown
- Defined in models/role/CertificateRoleModel.ts:94