Class Dwn

Index

Methods

close processMessage validateMessageIntegrity validateTenant create

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/dwn.ts:136

processMessage

processMessage(tenant, rawMessage): Promise<EventsGetReply>
Processes the given DWN message and returns with a reply.
Parameters
- tenant: string
  The tenant DID to route the given message to.
- rawMessage: EventsGetMessage
Returns Promise<EventsGetReply>
- Defined in src/dwn.ts:147
processMessage(tenant, rawMessage): Promise<EventsQueryReply>
Parameters
- tenant: string
- rawMessage: EventsQueryMessage
Returns Promise<EventsQueryReply>
- Defined in src/dwn.ts:148
processMessage(tenant, rawMessage, options?): Promise<EventsSubscribeReply>
Parameters
- tenant: string
- rawMessage: EventsSubscribeMessage
- Optional options: EventsSubscribeMessageOptions
Returns Promise<EventsSubscribeReply>
- Defined in src/dwn.ts:149
processMessage(tenant, rawMessage): Promise<MessagesGetReply>
Parameters
- tenant: string
- rawMessage: MessagesGetMessage
Returns Promise<MessagesGetReply>
- Defined in src/dwn.ts:151
processMessage(tenant, rawMessage): Promise<GenericMessageReply>
Parameters
- tenant: string
- rawMessage: ProtocolsConfigureMessage
Returns Promise<GenericMessageReply>
- Defined in src/dwn.ts:152
processMessage(tenant, rawMessage): Promise<ProtocolsQueryReply>
Parameters
- tenant: string
- rawMessage: ProtocolsQueryMessage
Returns Promise<ProtocolsQueryReply>
- Defined in src/dwn.ts:153
processMessage(tenant, rawMessage): Promise<GenericMessageReply>
Parameters
- tenant: string
- rawMessage: RecordsDeleteMessage
Returns Promise<GenericMessageReply>
- Defined in src/dwn.ts:154
processMessage(tenant, rawMessage): Promise<RecordsQueryReply>
Parameters
- tenant: string
- rawMessage: RecordsQueryMessage
Returns Promise<RecordsQueryReply>
- Defined in src/dwn.ts:155
processMessage(tenant, rawMessage, options): Promise<RecordsSubscribeReply>
Parameters
- tenant: string
- rawMessage: RecordsSubscribeMessage
- options: RecordsSubscribeMessageOptions
Returns Promise<RecordsSubscribeReply>
- Defined in src/dwn.ts:156
processMessage(tenant, rawMessage): Promise<RecordsReadReply>
Parameters
- tenant: string
- rawMessage: RecordsReadMessage
Returns Promise<RecordsReadReply>
- Defined in src/dwn.ts:158
processMessage(tenant, rawMessage, options?): Promise<GenericMessageReply>
Parameters
- tenant: string
- rawMessage: RecordsWriteMessage
- Optional options: RecordsWriteMessageOptions
Returns Promise<GenericMessageReply>
- Defined in src/dwn.ts:159
processMessage(tenant, rawMessage, options?): Promise<UnionMessageReply>
Parameters
- tenant: string
- rawMessage: unknown
- Optional options: MessageOptions
Returns Promise<UnionMessageReply>
- Defined in src/dwn.ts:160

validateMessageIntegrity

validateMessageIntegrity(rawMessage): Promise<undefined | GenericMessageReply>
Validates structure of DWN message
Parameters
- rawMessage: any
Returns Promise<undefined | GenericMessageReply>
GenericMessageReply if the message has an integrity error, otherwise undefined.
- Defined in src/dwn.ts:203

validateTenant

validateTenant(tenant): Promise<undefined | GenericMessageReply>
Checks tenant gate to see if tenant is allowed.
Parameters
- tenant: string
  The tenant DID to route the given message to.
Returns Promise<undefined | GenericMessageReply>
GenericMessageReply if the message has an integrity error, otherwise undefined.
- Defined in src/dwn.ts:185

`Static` create

create(config): Promise<Dwn>
Creates an instance of the DWN.
Parameters
- config: DwnConfig
Returns Promise<Dwn>
- Defined in src/dwn.ts:116

Class Dwn

Index

Methods

Methods

close

Returns Promise<void>

processMessage

Parameters

Returns Promise<EventsGetReply>

Parameters

Returns Promise<EventsQueryReply>

Parameters

Returns Promise<EventsSubscribeReply>

Parameters

Returns Promise<MessagesGetReply>

Parameters

Returns Promise<GenericMessageReply>

Parameters

Returns Promise<ProtocolsQueryReply>

Parameters

Returns Promise<GenericMessageReply>

Parameters

Returns Promise<RecordsQueryReply>

Parameters

Returns Promise<RecordsSubscribeReply>

Parameters

Returns Promise<RecordsReadReply>

Parameters

Returns Promise<GenericMessageReply>

Parameters

Returns Promise<UnionMessageReply>

validateMessageIntegrity

Parameters

Returns Promise<undefined | GenericMessageReply>

validateTenant

Parameters

Returns Promise<undefined | GenericMessageReply>

Static create

Parameters

Returns Promise<Dwn>

Settings

Member Visibility

Theme

On This Page

`Static` create