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
  - default

Implements

Role

Constructors

constructor

new default(roleName, leuteModel, issuers, config?): default
Constructor for the CertificateRoleModel.
Parameters
- roleName: string
  The name of the role.
- leuteModel: default
  The leute model.
- issuers: Role[]
- config: CertificateRoleConfig = {}
Returns default
Overrides default.constructor
- Defined in models/role/CertificateRoleModel.ts:89

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>
Implementation of Role.canCreate
Overrides default.canCreate
- Defined in models/role/CertificateRoleModel.ts:53

`Abstract`createCertificate

createCertificate(personId, issuerPersonId?): Promise<{
    certificate: UnversionedObjectResult<OneUnversionedObjectTypes>;
    license: UnversionedObjectResult<License>;
    signature: UnversionedObjectResult<Signature>;
}>
Parameters
- personId: SHA256IdHash<Person>
- OptionalissuerPersonId: SHA256IdHash<Person>
Returns Promise<{
    certificate: UnversionedObjectResult<OneUnversionedObjectTypes>;
    license: UnversionedObjectResult<License>;
    signature: UnversionedObjectResult<Signature>;
}>
- Defined in models/role/CertificateRoleModel.ts:63

`Abstract`getCertificates

getCertificates(personId): Promise<CertificateData[]>
Parameters
- personId: SHA256IdHash<Person>
Returns Promise<CertificateData[]>
- Defined in models/role/CertificateRoleModel.ts:60

`Abstract`getIssuerPersonIdsFromRoleCertificate

getIssuerPersonIdsFromRoleCertificate(rolePersonId): Promise<SHA256IdHash<Person>[]>
Parameters
- rolePersonId: SHA256IdHash<Person>
Returns Promise<SHA256IdHash<Person>[]>
- Defined in models/role/CertificateRoleModel.ts:57

getIssuers

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

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

`Abstract`getPersonIdFromRoleCertificate

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

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:100

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:132

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
- Defined in models/role/CertificateRoleModel.ts:225

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: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
- Defined in models/role/CertificateRoleModel.ts:238

hasMultipleCertificates

hasMultipleCertificates(personId): Promise<boolean>
Check if the person has multiple certificates
Parameters
- personId: SHA256IdHash<Person>
  The person id
Returns Promise<boolean>
True if the person has multiple certificates, false otherwise
- Defined in models/role/CertificateRoleModel.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.
Implementation of Role.hasSigned
Inherited from default.hasSigned
- Defined in models/role/BaseRoleModel.ts:141

init

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

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

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/CertificateRoleModel.ts:185

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:147

setRolePerson

setRolePerson(personId, issuerPersonId?): Promise<void>
Set the role person
Parameters
- personId: SHA256IdHash<Person>
  The person id
- OptionalissuerPersonId: SHA256IdHash<Person>
  The issuer person id
Returns Promise<void>
Implementation of Role.setRolePerson
Overrides default.setRolePerson
- Defined in models/role/CertificateRoleModel.ts:256

shareIssuers

shareIssuers(rolePersonId, shareWithPersonIds): Promise<void>
Share the issuers with the person ids
Parameters
- rolePersonId: SHA256IdHash<Person>
  The role person id
- shareWithPersonIds: SHA256IdHash<Person>[]
  The person ids to share with
Returns Promise<void>
Implementation of Role.shareIssuers
Overrides default.shareIssuers
- Defined in models/role/CertificateRoleModel.ts:203

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
    Whether to force the role person id from options.rolePersonId to propagate. Default is false.
  - OptionalrolePersonId?: SHA256IdHash<Person>
    The role person id. Default is the current person.
Returns Promise<void>
Implementation of Role.shareWith
Overrides default.shareWith
- Defined in models/role/CertificateRoleModel.ts:157

shutdown

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

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

Class defaultAbstract

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

onFound

onInitialised

onUpdated

state

Methods

AbstractcanCreate

Parameters

Returns boolean | Promise<boolean>

AbstractcreateCertificate

Parameters

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

AbstractgetCertificates

Parameters

Returns Promise<CertificateData[]>

AbstractgetIssuerPersonIdsFromRoleCertificate

Parameters

Returns Promise<SHA256IdHash<Person>[]>

getIssuers

Returns Promise<Role[]>

AbstractgetPersonIdFromRoleCertificate

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>

hasMultipleCertificates

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>

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

`Abstract`createCertificate

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

`Abstract`getCertificates

`Abstract`getIssuerPersonIdsFromRoleCertificate

`Abstract`getPersonIdFromRoleCertificate

`Optional`forcePropagate?: boolean

`Optional`rolePersonId?: SHA256IdHash<Person>