Class default

This class manages IoM requests.

The IoM Request is exchanged using IoMRequest objects that are locally registered at the IoMRequestRegistry.

The class allows you to create an IoMRequest that is distributed to the other participants. They are then notified through the onNewRequest event and can affirm the request. Affirmation works by creating an affirmation certificate that is then distributed back to all other participants.

TODO:

At the moment we cannot decline the request, only ignore it.
At the moment you should only create 1:1 requests, because if you have more participants the synchronization between all participants is complicated. Therefore we might remove support for multiple participants in the future when adding the ability to decline requests.

Index

Constructors

constructor

new default(trustedKeysManager): default
Parameters
- trustedKeysManager: default
Returns default
- Defined in models/IoM/IoMRequestManager.ts:61

Properties

onError

onError: OEvent<((message: any) => void)> = ...

onNewRequest

onNewRequest: OEvent<((requestHash: SHA256Hash<IoMRequest>, request: IoMRequest) => void)> = ...

onRequestComplete

onRequestComplete: OEvent<((requestHash: SHA256Hash<IoMRequest>, request: IoMRequest) => void)> = ...

onRequestUpdate

onRequestUpdate: OEvent<((requestHash: SHA256Hash<IoMRequest>, request: IoMRequest) => void)> = ...

Methods

affirmRequest

affirmRequest(requestHash): Promise<void>
Affirm an IoMRequest - this means that you want to join the IoM.
Parameters
- requestHash: SHA256Hash<IoMRequest>
Returns Promise<void>
- Defined in models/IoM/IoMRequestManager.ts:140

allRequests

allRequests(): Promise<{
    active: boolean;
    request: IoMRequest;
    requestHash: SHA256Hash<IoMRequest>;
}[]>
Obtain all requests.

Returns Promise<{
    active: boolean;
    request: IoMRequest;
    requestHash: SHA256Hash<IoMRequest>;
}[]>
- Defined in models/IoM/IoMRequestManager.ts:148

createIoMRequest

createIoMRequest(initiator, mainId, alternateId, mode?): Promise<void>
Creates a new IoM request.
Parameters
- initiator: SHA256IdHash<Person>
  The person who initiated the request
- mainId: SHA256IdHash<Person>
  The identity that becomes the main identity on both sides
- alternateId: SHA256IdHash<Person>
  The identity that will become an alternate identity (not main)
- mode: "full" | "light" = 'full'
  'full' means that both identities will get private keys on both sides 'light' means that only the main identity will get private keys on both sides
Returns Promise<void>
- Defined in models/IoM/IoMRequestManager.ts:116

init

init(): Promise<void>
Init the request manager.

Returns Promise<void>
- Defined in models/IoM/IoMRequestManager.ts:70

shutdown

shutdown(): Promise<void>
Shutdown the request manager.

Returns Promise<void>
- Defined in models/IoM/IoMRequestManager.ts:96

Class default

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

onError

onNewRequest

onRequestComplete

onRequestUpdate

Methods

affirmRequest

Parameters

Returns Promise<void>

allRequests

Returns Promise<{
    active: boolean;
    request: IoMRequest;
    requestHash: SHA256Hash<IoMRequest>;
}[]>

createIoMRequest

Parameters

Returns Promise<void>

init

Returns Promise<void>

shutdown

Returns Promise<void>

Settings

On This Page

Class default

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

onError

onNewRequest

onRequestComplete

onRequestUpdate

Methods

affirmRequest

Parameters

Returns Promise<void>

allRequests

Returns Promise<{ active: boolean; request: IoMRequest; requestHash: SHA256Hash<IoMRequest>; }[]>

createIoMRequest

Parameters

Returns Promise<void>

init

Returns Promise<void>

shutdown

Returns Promise<void>

Settings

On This Page

Returns Promise<{
active: boolean;
request: IoMRequest;
requestHash: SHA256Hash<IoMRequest>;
}[]>