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

Constructors

constructor

new default(leuteModel, issuers, config?): default
Constructor for the AffirmedProfileRoleModel.
Parameters
- leuteModel: default
  The leute model.
- issuers: default[]
- config: Partial<Config> = {}
Returns default
Overrides default.constructor
- Defined in models/role/AffirmedProfileRoleModel.ts:84

Properties

onFound

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

onInitialised

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

state

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

`Static`roleName

roleName: string

Methods

`Abstract`canCreate

canCreate(roleName): boolean | Promise<boolean>
************* Abstracts **************
Parameters
- roleName: string
Returns boolean | Promise<boolean>
Overrides default.canCreate
- Defined in models/role/AffirmedProfileRoleModel.ts:55

getCertificates

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

getIssuerPersonIdsFromRoleCertificate

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

getIssuers

getIssuers(): Promise<default[]>
************* Semi-abstracts **************

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

getRoleName

getRoleName(): string
Returns the name of the role.

Returns string
The name of the role.
Inherited from default.getRoleName
- Defined in models/role/Role.ts:119

getRolePersonIds

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

Returns Promise<SHA256IdHash<Person>[]>
The role person ids.
Overrides default.getRolePersonIds
- Defined in models/role/AffirmedProfileRoleModel.ts:161

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/Role.ts:129

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/Role.ts:160

init

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

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

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/Role.ts:111

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.
Overrides default.isRolePerson
- Defined in models/role/AffirmedProfileRoleModel.ts:153

`Abstract`setRolePerson

setRolePerson(personId, creatorId?): Promise<void>
Parameters
- personId: SHA256IdHash<Person>
- OptionalcreatorId: SHA256IdHash<Person>
Returns Promise<void>
Overrides default.setRolePerson
- Defined in models/role/AffirmedProfileRoleModel.ts:56

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>
Overrides default.shareIssuers
- Defined in models/role/AffirmedProfileRoleModel.ts:632

shareWith

shareWith(shareWithPersonIds, options?): Promise<void>
Shares the role data with the others.
Parameters
- shareWithPersonIds: SHA256IdHash<Person>[]
  The person ids to share with.
- options: {
  forcePropagate?: boolean;
  rolePersonId?: SHA256IdHash<Person>;
  } = {}
  - OptionalforcePropagate?: boolean
    Whether to force the propagation of options.rolePersonId. Default is false.
  - OptionalrolePersonId?: SHA256IdHash<Person>
    The role person id. Default is the current person.
Returns Promise<void>
Overrides default.shareWith
- Defined in models/role/AffirmedProfileRoleModel.ts:177

shutdown

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

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

Class defaultAbstract

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

onFound

onInitialised

state

StaticroleName

Methods

AbstractcanCreate

Parameters

Returns boolean | Promise<boolean>

getCertificates

Parameters

Returns Promise<CertificateData<AffirmationCertificate>[]>

getIssuerPersonIdsFromRoleCertificate

Parameters

Returns Promise<SHA256IdHash<Person>[]>

getIssuers

Returns Promise<default[]>

getRoleName

Returns string

getRolePersonIds

Returns Promise<SHA256IdHash<Person>[]>

hasAffirmed

Parameters

Returns Promise<boolean>

hasSigned

Parameters

Returns Promise<boolean>

init

Returns Promise<void>

isInitialised

Returns boolean

isRolePerson

Parameters

Returns Promise<boolean>

AbstractsetRolePerson

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`

`Static`roleName

`Abstract`canCreate

`Abstract`setRolePerson

`Optional`forcePropagate?: boolean

`Optional`rolePersonId?: SHA256IdHash<Person>