Class default`Abstract`

Application of CertificateRoleModel for relation certificates.

Hierarchy (view full)

default
- default

Constructors

constructor

new default(roleName, leuteModel, roleApp, roleRelation, config?): default
Constructor for the RelationRoleModel
Parameters
- roleName: string
  The name of the role
- leuteModel: default
  The leute model
- roleApp: string
  The app of the role
- roleRelation: string
  The relation of the role
- Optionalconfig: Partial<CertificateRoleConfig> & RelationRoleConfig
  The config of the role
Returns default
Overrides default.constructor
- Defined in models/role/RelationRoleModel.ts:51

Properties

onFound

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

onInitialised

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

onUpdated

onUpdated: OEvent<(() => void)> = ...

state

state: StateMachine<"Uninitialised" | "Initialised", "shutdown" | "init">

Methods

`Abstract`canCreate

canCreate(roleName): boolean | Promise<boolean>
************* Abstracts **************
Parameters
- roleName: string
Returns boolean | Promise<boolean>
Inherited from default.canCreate
- Defined in models/role/CertificateRoleModel.ts:50

createRelationCertificate

createRelationCertificate(personId, issuerId?): Promise<{
    certificate: UnversionedObjectResult<RelationCertificate>;
    license: UnversionedObjectResult<License>;
    signature: UnversionedObjectResult<Signature>;
}>
Create a relation certificate
Parameters
- personId: SHA256IdHash<Person>
- OptionalissuerId: SHA256IdHash<Person>
  The issuer id
Returns Promise<{
    certificate: UnversionedObjectResult<RelationCertificate>;
    license: UnversionedObjectResult<License>;
    signature: UnversionedObjectResult<Signature>;
}>
The relation certificate
- Defined in models/role/RelationRoleModel.ts:275

getCertificates

getCertificates(personId): Promise<CertificateData<RelationCertificate>[]>
Get the certificates for a person
Parameters
- personId: SHA256IdHash<Person>
  The person id
Returns Promise<CertificateData<RelationCertificate>[]>
The certificates
- Defined in models/role/RelationRoleModel.ts:151

getIssuerPersonIdFromRoleCertificate

getIssuerPersonIdFromRoleCertificate(data): Promise<undefined | SHA256IdHash<Person>>
Parameters
- data: OneObjectTypes
Returns Promise<undefined | SHA256IdHash<Person>>
- Defined in models/role/RelationRoleModel.ts:322

getIssuerPersonIdsFromRoleCertificate

getIssuerPersonIdsFromRoleCertificate(therapistId): Promise<SHA256IdHash<Person>[]>
Get the issuer person ids from the role certificate
Parameters
- therapistId: SHA256IdHash<Person>
  The therapist id
Returns Promise<SHA256IdHash<Person>[]>
The issuer person ids
- Defined in models/role/RelationRoleModel.ts:136

getIssuers

getIssuers(): Promise<Role[]>
************* may not be implemented by all roles **************

Returns Promise<Role[]>
Inherited from default.getIssuers
- Defined in models/role/BaseRoleModel.ts:50

getPersonIdFromRoleCertificate

getPersonIdFromRoleCertificate(data): Promise<undefined | SHA256IdHash<Person>>
Get the person id from the role certificate
Parameters
- data: OneObjectTypes
  The role certificate
Returns Promise<undefined | SHA256IdHash<Person>>
The person id
Overrides default.getPersonIdFromRoleCertificate
- Defined in models/role/RelationRoleModel.ts:94

getRoleName

getRoleName(): string
Returns the role name.

Returns string
The role name.
Inherited from default.getRoleName
- Defined in models/role/BaseRoleModel.ts:100

getRolePersonIds

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

Returns Promise<SHA256IdHash<Person>[]>
The role person ids.
Inherited from default.getRolePersonIds
- Defined in models/role/CertificateRoleModel.ts:108

getSignatureHashes

getSignatureHashes(personId): Promise<undefined | SHA256Hash[]>
Get the signature hash for a person
Parameters
- personId: SHA256IdHash<Person>
  The person id
Returns Promise<undefined | SHA256Hash[]>
The signature hash
Overrides default.getSignatureHashes
- Defined in models/role/RelationRoleModel.ts:234

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.
Inherited from default.hasAffirmed
- Defined in models/role/BaseRoleModel.ts:110

hasCertificate

hasCertificate(personId): Promise<boolean>
Check if the person has a certificate
Parameters
- personId: SHA256IdHash<Person>
  The person id
Returns Promise<boolean>
True if the person has a certificate, false otherwise
Overrides default.hasCertificate
- Defined in models/role/RelationRoleModel.ts:247

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.
Inherited from default.hasSigned
- Defined in models/role/BaseRoleModel.ts:141

init

init(): Promise<void>
Initialize the role

Returns Promise<void>
Overrides default.init
- Defined in models/role/RelationRoleModel.ts:64

isInitialised

isInitialised(): boolean
Returns true if the role is initialised.

Returns boolean
True if the role is initialised, false otherwise.
Inherited from default.isInitialised
- Defined in models/role/BaseRoleModel.ts:92

isIssuer

isIssuer(personId): Promise<boolean>
Check if the person is an issuer
Parameters
- personId: SHA256IdHash<Person>
  The person id
Returns Promise<boolean>
True if the person is an issuer or no issuers are set, false otherwise
- Defined in models/role/RelationRoleModel.ts:118

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.
Inherited from default.isRolePerson
- Defined in models/role/CertificateRoleModel.ts:121

isRoleRelationCertificate

isRoleRelationCertificate(data, rolePersonId?): Promise<boolean>
Check if the certificate is a role relation certificate
Parameters
- data: OneObjectTypes
  The certificate
- OptionalrolePersonId: SHA256IdHash<Person>
  The role person id
Returns Promise<boolean>
True if the certificate is a role relation certificate, false otherwise
- Defined in models/role/RelationRoleModel.ts:174

setRolePerson

setRolePerson(personId, issuerPersonId?): Promise<void>
Parameters
- personId: SHA256IdHash<Person>
- OptionalissuerPersonId: SHA256IdHash<Person>
Returns Promise<void>
Overrides default.setRolePerson
- Defined in models/role/RelationRoleModel.ts:251

shareIssuers

shareIssuers(rolePersonId, shareWithPersonIds): Promise<void>
Share the issuers with the person ids
Parameters
- rolePersonId: SHA256IdHash<Person>
- shareWithPersonIds: SHA256IdHash<Person>[]
Returns Promise<void>
Overrides default.shareIssuers
- Defined in models/role/RelationRoleModel.ts:215

shareWith

shareWith(shareWithPersonIds, options?): Promise<void>
Shares the role with the given person ids.
Parameters
- shareWithPersonIds: SHA256IdHash<Person>[]
  The person ids to share with.
- options: {
  forcePropagate?: boolean;
  rolePersonId?: SHA256IdHash<Person>;
  } = {}
  - OptionalforcePropagate?: boolean
  - OptionalrolePersonId?: SHA256IdHash<Person>
Returns Promise<void>
Inherited from default.shareWith
- Defined in models/role/CertificateRoleModel.ts:130

shutdown

shutdown(): Promise<void>
Shutdown the role

Returns Promise<void>
Overrides default.shutdown
- Defined in models/role/RelationRoleModel.ts:81

Class defaultAbstract

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

onFound

onInitialised

onUpdated

state

Methods

AbstractcanCreate

Parameters

Returns boolean | Promise<boolean>

createRelationCertificate

Parameters

Returns Promise<{ certificate: UnversionedObjectResult<RelationCertificate>; license: UnversionedObjectResult<License>; signature: UnversionedObjectResult<Signature>; }>

getCertificates

Parameters

Returns Promise<CertificateData<RelationCertificate>[]>

getIssuerPersonIdFromRoleCertificate

Parameters

Returns Promise<undefined | SHA256IdHash<Person>>

getIssuerPersonIdsFromRoleCertificate

Parameters

Returns Promise<SHA256IdHash<Person>[]>

getIssuers

Returns Promise<Role[]>

getPersonIdFromRoleCertificate

Parameters

Returns Promise<undefined | SHA256IdHash<Person>>

getRoleName

Returns string

getRolePersonIds

Returns Promise<SHA256IdHash<Person>[]>

getSignatureHashes

Parameters

Returns Promise<undefined | SHA256Hash[]>

hasAffirmed

Parameters

Returns Promise<boolean>

hasCertificate

Parameters

Returns Promise<boolean>

hasSigned

Parameters

Returns Promise<boolean>

init

Returns Promise<void>

isInitialised

Returns boolean

isIssuer

Parameters

Returns Promise<boolean>

isRolePerson

Parameters

Returns Promise<boolean>

isRoleRelationCertificate

Parameters

Returns Promise<boolean>

setRolePerson

Parameters

Returns Promise<void>

shareIssuers

Parameters

Returns Promise<void>

shareWith

Parameters

OptionalforcePropagate?: boolean

OptionalrolePersonId?: SHA256IdHash<Person>

Returns Promise<void>

shutdown

Returns Promise<void>

Settings

On This Page

Class default`Abstract`

`Abstract`canCreate

Returns Promise<{
certificate: UnversionedObjectResult<RelationCertificate>;
license: UnversionedObjectResult<License>;
signature: UnversionedObjectResult<Signature>;
}>

`Optional`forcePropagate?: boolean

`Optional`rolePersonId?: SHA256IdHash<Person>