Class: RiseMessage

new RiseMessage(solution, bodyopt, headopt)

Interface allowing for authenticated message exchange.

Parameters:

Name	Type	Attributes	Description
`solution`	RiseSolution		Identity solution data.
`body`	Object.<string, string>	<optional>	Key-value data to include.
`head`	Object.<string, string>	<optional>	Additional headers.

Source: index.js, line 330

Members

body :Object.<string, string>|string

Key-value pairs given for the message.

Type:

Object.<string, string> | string

Source: index.js, line 346

head :RiseMessage~Head

Default message headers, plus any custom ones supplied.

Type:

RiseMessage~Head

Source: index.js, line 335

Methods

encrypt(publicKey) → {EncryptedRiseMessage}

Encrypts the message state for the public key provided.

Parameters:

Name	Type	Description
`publicKey`	Uint8Array \| buffer	Recipient public key.

Source: index.js, line 356

Returns:

Type:: EncryptedRiseMessage

sign(privateKey) → {SignedRiseMessage}

Signs the message state using the private key provided.

Parameters:

Name	Type	Description
`privateKey`	Uint8Array \| buffer	Identity to use for signature.

Source: index.js, line 370

Returns:

Type:: SignedRiseMessage

toBuffer() → {buffer}

Serializes the message to wire format.

Source: index.js, line 402

Returns:

Type:: buffer

unwrap() → {Object.<string, (string|RiseMessage|EncryptedRiseMessage|SignedRiseMessage|string)>}

Returns only the body of this message.

Source: index.js, line 386

Returns:

Type:: Object.<string, (string|RiseMessage|EncryptedRiseMessage|SignedRiseMessage|string)>

validate() → {boolean}

Ensures the solution header is valid.

Source: index.js, line 394

Returns:

Type:: boolean

(static) fromBuffer(message) → {RiseMessage|EncryptedRiseMessage|SignedRiseMessage}

Creates a new message instance from the serialized message.

Parameters:

Name	Type	Description
`message`	buffer	Binary blob to deserialize.

Source: index.js, line 418

Returns:

Type:: RiseMessage | EncryptedRiseMessage | SignedRiseMessage