Class default`Abstract`

A model that represents a sign key role.

Note: Depends on the reverse maps of the LeuteModel to be able to find the someone from the personId.

Hierarchy (view full)

default
- default

Implements

Role

Index

Constructors

constructor

new default(roleName, leuteModel, roleSignKeys, config?): default
Constructs a new SignKeyRoleModel.
Parameters
- roleName: string
- leuteModel: default
  The LeuteModel instance.
- roleSignKeys: HexString[]
  The public sign keys of the role.
- config: Config = ...
  The config for the SignKeyRoleModel.
Returns default
Overrides default.constructor
- Defined in models/role/SignKeyRoleModel.ts:57

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/SignKeyRoleModel.ts:35

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

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>[]>
Gets the personIds of the sign key role.

Returns Promise<SHA256IdHash<Person>[]>
The personIds of the sign key role in an one indexed array or an empty array if not found.
Implementation of Role.getRolePersonIds
Overrides default.getRolePersonIds
- Defined in models/role/SignKeyRoleModel.ts:115

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

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 SignKeyRoleModel.

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

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

isRolePerson

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

setRolePerson

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

shareIssuers

shareIssuers(_rolePersonId, _shareWithPersonIds): Promise<void>
Parameters
- _rolePersonId: SHA256IdHash<Person>
- _shareWithPersonIds: SHA256IdHash<Person>[]
Returns Promise<void>
Implementation of Role.shareIssuers
Inherited from default.shareIssuers
- Defined in models/role/BaseRoleModel.ts:55

shareWith

shareWith(withPersonIds, options?): Promise<void>
Shares the sign key role with the given person.
Parameters
- withPersonIds: SHA256IdHash<Person>[]
  The personIds to share the sign key role with.
- options: {
  forcePropagate?: boolean;
  rolePersonId?: SHA256IdHash<Person>;
  } = {}
  - OptionalforcePropagate?: boolean
  - OptionalrolePersonId?: SHA256IdHash<Person>
Returns Promise<void>
Implementation of Role.shareWith
Overrides default.shareWith
- Defined in models/role/SignKeyRoleModel.ts:128

shutdown

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

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

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>

getIssuers

Returns Promise<Role[]>

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>

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

`Optional`forcePropagate?: boolean

`Optional`rolePersonId?: SHA256IdHash<Person>