Class RecordsQuery

A class representing a RecordsQuery DWN message.

Hierarchy

AbstractMessage<RecordsQueryMessage>
- RecordsQuery

Index

Accessors

author message signaturePayload signer

Methods

authorizeDelegate toJSON create parse

Accessors

author

get author(): undefined | string
Returns undefined | string
Inherited from AbstractMessage.author
- Defined in src/core/abstract-message.ts:22

message

get message(): M
Returns M
Inherited from AbstractMessage.message
- Defined in src/core/abstract-message.ts:12

signaturePayload

get signaturePayload(): undefined | GenericSignaturePayload
Returns undefined | GenericSignaturePayload
Inherited from AbstractMessage.signaturePayload
- Defined in src/core/abstract-message.ts:27

signer

get signer(): undefined | string
Returns undefined | string
Inherited from AbstractMessage.signer
- Defined in src/core/abstract-message.ts:17

Methods

authorizeDelegate

authorizeDelegate(messageStore): Promise<void>
Authorizes the delegate who signed this message.
Parameters
- messageStore: MessageStore
  Used to check if the grant has been revoked.
Returns Promise<void>
- Defined in src/interfaces/records-query.ts:121

toJSON

toJSON(): GenericMessage
Called by JSON.stringify(...) automatically.

Returns GenericMessage
Inherited from AbstractMessage.toJSON
- Defined in src/core/abstract-message.ts:52

`Static` create

create(options): Promise<RecordsQuery>
Parameters
- options: RecordsQueryOptions
Returns Promise<RecordsQuery>
- Defined in src/interfaces/records-query.ts:76

`Static` parse

parse(message): Promise<RecordsQuery>
Parameters
- message: RecordsQueryMessage
Returns Promise<RecordsQuery>
- Defined in src/interfaces/records-query.ts:37