Class Message

A class containing utility methods for working with DWN messages.

Index

Constructors

Methods

compareCid compareMessageTimestamp createAuthorization createSignature getAuthor getCid getNewestMessage getOldestMessage getSigner isNewer isOlder isSignedByAuthorDelegate isSignedByOwnerDelegate validateJsonSchema validateSignatureStructure

Constructors

constructor

new Message(): Message
Returns Message

Methods

`Static`compareCid

compareCid(a, b): Promise<number>
Compares message CID in lexicographical order according to the spec.
Parameters
- a: GenericMessage
- b: GenericMessage
Returns Promise<number>
1 if a is larger than b; -1 if a is smaller/older than b; 0 otherwise (same message)
- Defined in src/core/message.ts:86

`Static`compareMessageTimestamp

compareMessageTimestamp(a, b): Promise<number>
Compares the messageTimestamp of the given messages with a fallback to message CID according to the spec.
Parameters
- a: GenericMessage
- b: GenericMessage
Returns Promise<number>
1 if a is larger/newer than b; -1 if a is smaller/older than b; 0 otherwise (same age)
- Defined in src/core/message.ts:211

`Static`createAuthorization

createAuthorization(input): Promise<AuthorizationModel>
Creates the authorization property to be included in a DWN message.
Parameters
- input: {
      delegatedGrant?: DataEncodedRecordsWriteMessage;
      descriptor: Descriptor;
      permissionGrantId?: string;
      protocolRole?: string;
      signer: Signer;
  }
  - OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage
  - descriptor: Descriptor
  - OptionalpermissionGrantId?: string
  - OptionalprotocolRole?: string
  - signer: Signer
Returns Promise<AuthorizationModel>
used as an authorization property.
- Defined in src/core/message.ts:98

`Static`createSignature

createSignature(descriptor, signer, additionalPayloadProperties?): Promise<GeneralJws>
Creates a generic signature from the given DWN message descriptor by including descriptorCid as the required property in the signature payload. NOTE: there is an opportunity to consolidate RecordsWrite.createSignerSignature() wth this method
Parameters
- descriptor: Descriptor
- signer: Signer
- OptionaladditionalPayloadProperties: {
      delegatedGrantId?: string;
      permissionGrantId?: string;
      protocolRole?: string;
  }
  - OptionaldelegatedGrantId?: string
  - OptionalpermissionGrantId?: string
  - OptionalprotocolRole?: string
Returns Promise<GeneralJws>
- Defined in src/core/message.ts:129

`Static`getAuthor

getAuthor(message): undefined | string
Gets the DID of the author of the given message.
Parameters
- message: GenericMessage
Returns undefined | string
- Defined in src/core/message.ts:23

`Static`getCid

getCid(message): Promise<string>
Gets the CID of the given message.
Parameters
- message: GenericMessage
Returns Promise<string>
- Defined in src/core/message.ts:66

`Static`getNewestMessage

getNewestMessage(messages): Promise<undefined | GenericMessage>
Parameters
- messages: GenericMessage[]
Returns Promise<undefined | GenericMessage>
newest message in the array. undefined if given array is empty.
- Defined in src/core/message.ts:150

`Static`getOldestMessage

getOldestMessage(messages): Promise<undefined | GenericMessage>
Parameters
- messages: GenericMessage[]
Returns Promise<undefined | GenericMessage>
oldest message in the array. undefined if given array is empty.
- Defined in src/core/message.ts:164

`Static`getSigner

getSigner(message): undefined | string
Gets the DID of the signer of the given message, returns undefined if message is not signed.
Parameters
- message: GenericMessage
Returns undefined | string
- Defined in src/core/message.ts:54

`Static`isNewer

isNewer(a, b): Promise<boolean>
Checks if first message is newer than second message.
Parameters
- a: GenericMessage
- b: GenericMessage
Returns Promise<boolean>
true if a is newer than b; false otherwise
- Defined in src/core/message.ts:179

`Static`isOlder

isOlder(a, b): Promise<boolean>
Checks if first message is older than second message.
Parameters
- a: GenericMessage
- b: GenericMessage
Returns Promise<boolean>
true if a is older than b; false otherwise
- Defined in src/core/message.ts:188

`Static`isSignedByAuthorDelegate

isSignedByAuthorDelegate(message): boolean
See if the given message is signed by an author-delegate.
Parameters
- message: GenericMessage
Returns boolean
- Defined in src/core/message.ts:196

`Static`isSignedByOwnerDelegate

isSignedByOwnerDelegate(message): boolean
See if the given message is signed by an owner-delegate.
Parameters
- message: GenericMessage
Returns boolean
- Defined in src/core/message.ts:203

`Static`validateJsonSchema

validateJsonSchema(rawMessage): void
Validates the given message against the corresponding JSON schema.
Parameters
- rawMessage: any
Returns void
Throws
if fails validation.
- Defined in src/core/message.ts:42

`Static`validateSignatureStructure

validateSignatureStructure(messageSignature, messageDescriptor, payloadJsonSchemaKey?): Promise<GenericSignaturePayload>
Validates the structural integrity of the message signature given:
1. The message signature must contain exactly 1 signature
2. Passes JSON schema validation
3. The descriptorCid property matches the CID of the message descriptor NOTE: signature is NOT verified.
Parameters
- messageSignature: GeneralJws
- messageDescriptor: Descriptor
- payloadJsonSchemaKey: string = 'GenericSignaturePayload'
  The key to look up the JSON schema referenced in compile-validators.js and perform payload schema validation on.
Returns Promise<GenericSignaturePayload>
the parsed JSON payload object if validation succeeds.
- Defined in src/core/message.ts:232

Class Message

Index

Constructors

Methods

Constructors

constructor

Returns Message

Methods

StaticcompareCid

Parameters

Returns Promise<number>

StaticcompareMessageTimestamp

Parameters

Returns Promise<number>

StaticcreateAuthorization

Parameters

OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

descriptor: Descriptor

OptionalpermissionGrantId?: string

OptionalprotocolRole?: string

signer: Signer

Returns Promise<AuthorizationModel>

StaticcreateSignature

Parameters

OptionaldelegatedGrantId?: string

OptionalpermissionGrantId?: string

OptionalprotocolRole?: string

Returns Promise<GeneralJws>

StaticgetAuthor

Parameters

Returns undefined | string

StaticgetCid

Parameters

Returns Promise<string>

StaticgetNewestMessage

Parameters

Returns Promise<undefined | GenericMessage>

StaticgetOldestMessage

Parameters

Returns Promise<undefined | GenericMessage>

StaticgetSigner

Parameters

Returns undefined | string

StaticisNewer

Parameters

Returns Promise<boolean>

StaticisOlder

Parameters

Returns Promise<boolean>

StaticisSignedByAuthorDelegate

Parameters

Returns boolean

StaticisSignedByOwnerDelegate

Parameters

Returns boolean

StaticvalidateJsonSchema

Parameters

Returns void

Throws

StaticvalidateSignatureStructure

Parameters

Returns Promise<GenericSignaturePayload>

Settings

On This Page

`Static`compareCid

`Static`compareMessageTimestamp

`Static`createAuthorization

`Optional`delegatedGrant?: DataEncodedRecordsWriteMessage

`Optional`permissionGrantId?: string

`Optional`protocolRole?: string

`Static`createSignature

`Optional`delegatedGrantId?: string

`Optional`permissionGrantId?: string

`Optional`protocolRole?: string

`Static`getAuthor

`Static`getCid

`Static`getNewestMessage

`Static`getOldestMessage

`Static`getSigner

`Static`isNewer

`Static`isOlder

`Static`isSignedByAuthorDelegate

`Static`isSignedByOwnerDelegate

`Static`validateJsonSchema

`Static`validateSignatureStructure