MediatorConnection
@hyperledger/identus-sdk v7.0.0
@hyperledger/identus-sdk / plugins/internal/didcomm / MediatorConnection
Class: MediatorConnection
Defined in: src/plugins/internal/didcomm/connection/MediatorConnection.ts:6
Define the structure of a Connection
Connections are used to capture Protocol specific behaviours and metadata
Extends
Constructors
Constructor
new MediatorConnection(
uri:string,host:string,routingDID?:string):MediatorConnection
Defined in: src/plugins/internal/didcomm/connection/MediatorConnection.ts:9
Parameters
| Parameter | Type |
|---|---|
uri | string |
host | string |
routingDID? | string |
Returns
MediatorConnection
Overrides
Properties
| Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
|---|---|---|---|---|---|---|
alias? | readonly | string | undefined | - | DIDCommConnection.alias | src/plugins/internal/didcomm/connection/DIDCommConnection.ts:15 |
host | readonly | string | undefined | - | DIDCommConnection.host | src/plugins/internal/didcomm/connection/MediatorConnection.ts:11 |
routingDID? | public | string | undefined | - | - | src/plugins/internal/didcomm/connection/MediatorConnection.ts:12 |
state | public | State | Connection.State.NEW | current condition of the connection | DIDCommConnection.state | src/plugins/internal/didcomm/connection/DIDCommConnection.ts:10 |
type | readonly | "DIDComm" | "DIDComm" | - | DIDCommConnection.type | src/plugins/internal/didcomm/connection/DIDCommConnection.ts:9 |
uri | readonly | string | undefined | unique identifer for the connection | DIDCommConnection.uri | src/plugins/internal/didcomm/connection/MediatorConnection.ts:10 |
Accessors
liveMode
Get Signature
get liveMode():
boolean
Defined in: src/plugins/internal/didcomm/connection/MediatorConnection.ts:17
Returns
boolean
Methods
asMediator()
asMediator():
Mediator
Defined in: src/plugins/internal/didcomm/connection/MediatorConnection.ts:21
Returns
close()
close():
Promise<void>
Defined in: src/plugins/internal/didcomm/connection/MediatorConnection.ts:29
Returns
Promise<void>
receive()
receive(
message:Message|undefined,ctx:AgentContext):Promise<any>
Defined in: src/plugins/internal/didcomm/connection/DIDCommConnection.ts:34
called when a Message is received from this connection
Parameters
| Parameter | Type |
|---|---|
message | Message | undefined |
ctx | AgentContext |
Returns
Promise<any>
Inherited from
send()
send(
msg:Message,ctx:AgentContext):Promise<any>
Defined in: src/plugins/internal/didcomm/connection/DIDCommConnection.ts:18
handle delivering a Message to the connected entity
Parameters
| Parameter | Type |
|---|---|
msg | Message |
ctx | AgentContext |
Returns
Promise<any>
Inherited from
useLiveMode()
useLiveMode(
socket:WebSocket):Promise<void>
Defined in: src/plugins/internal/didcomm/connection/MediatorConnection.ts:34
Parameters
| Parameter | Type |
|---|---|
socket | WebSocket |
Returns
Promise<void>