DIDCommConnection

@hyperledger/identus-sdk v7.0.0

---

@hyperledger/identus-sdk / plugins/internal/didcomm / DIDCommConnection

Class: DIDCommConnection

Defined in: src/plugins/internal/didcomm/connection/DIDCommConnection.ts:8

Define the structure of a Connection

Connections are used to capture Protocol specific behaviours and metadata

Extended by

• MediatorConnection

Implements

• Connection

Constructors

Constructor

new DIDCommConnection(uri: string, host: string, alias?: string): DIDCommConnection

Defined in: src/plugins/internal/didcomm/connection/DIDCommConnection.ts:12

Parameters

Parameter	Type
uri	string
host	string
alias?	string

Returns

DIDCommConnection

Properties

Property	Modifier	Type	Default value	Description	Defined in
alias?	readonly	string	undefined	-	src/plugins/internal/didcomm/connection/DIDCommConnection.ts:15
host	readonly	string	undefined	-	src/plugins/internal/didcomm/connection/DIDCommConnection.ts:14
state	public	State	Connection.State.NEW	current condition of the connection	src/plugins/internal/didcomm/connection/DIDCommConnection.ts:10
type	readonly	"DIDComm"	"DIDComm"	-	src/plugins/internal/didcomm/connection/DIDCommConnection.ts:9
uri	readonly	string	undefined	unique identifer for the connection	src/plugins/internal/didcomm/connection/DIDCommConnection.ts:13

Methods

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>

Implementation of

Connection.receive

---

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>

Implementation of

Connection.send