Class RecordsSubscribe

A class representing a RecordsSubscribe DWN message.

Hierarchy

AbstractMessage<RecordsSubscribeMessage>
- RecordsSubscribe

Index

Accessors

author isSignedByAuthorDelegate message signaturePayload signer

Methods

authorizeDelegate toJSON create parse

Accessors

author

get author(): undefined | string
DID of the logical author of this message. NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, in which case the author DID would not be the same as the signer/delegate DID, but be the DID of the grantor (grantedBy) of the delegated grant presented.

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

isSignedByAuthorDelegate

get isSignedByAuthorDelegate(): boolean
If this message is signed by an author-delegate.

Returns boolean
Inherited from AbstractMessage.isSignedByAuthorDelegate
- Defined in src/core/abstract-message.ts:34

message

get message(): M
Valid JSON message representing this DWN message.

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

signaturePayload

get signaturePayload(): undefined | GenericSignaturePayload
Decoded payload of the signature of this message.

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

signer

get signer(): undefined | string
Gets the signer of this message. This is not to be confused with the logical author of the message.

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 the message.
Parameters
- messageStore: MessageStore
  Used to check if the grant has been revoked.
Returns Promise<void>
- Defined in src/interfaces/records-subscribe.ts:94

toJSON

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

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

`Static`create

create(options): Promise<RecordsSubscribe>
Parameters
- options: RecordsSubscribeOptions
Returns Promise<RecordsSubscribe>
- Defined in src/interfaces/records-subscribe.ts:60

`Static`parse

parse(message): Promise<RecordsSubscribe>
Parameters
- message: RecordsSubscribeMessage
Returns Promise<RecordsSubscribe>
- Defined in src/interfaces/records-subscribe.ts:33