Class MessageEncoder

Encrypts and encodes messages between two parties.

Index

Constructors

Accessors

Methods

encode encodeDeprecated tryDecode

Constructors

constructor

new MessageEncoder(keyPair): MessageEncoder
Creates message encoder around key pair.
Parameters
- keyPair: KeyPair
  Key pair.
Returns MessageEncoder
- Defined in nem/MessageEncoder.d.ts:9

Accessors

publicKey

get publicKey(): PublicKey
Public key used for message encoding.

Returns PublicKey
Public key used for message encoding.
- Defined in nem/MessageEncoder.d.ts:18

Methods

encode

encode(recipientPublicKey, message): Message
Encodes message to recipient using recommended format.
Parameters
- recipientPublicKey: PublicKey
  Recipient public key.
- message: Uint8Array
  Message to encode.
Returns Message
Encrypted and encoded message.
- Defined in nem/MessageEncoder.d.ts:32

encodeDeprecated

encodeDeprecated(recipientPublicKey, message): Message
Encodes message to recipient using recommended format.
Parameters
- recipientPublicKey: PublicKey
  Recipient public key.
- message: Uint8Array
  Message to encode.
Returns Message
Encrypted and encoded message.

Deprecated
This function is only provided for compatability with older NEM messages. Please use encode in any new code.
- Defined in nem/MessageEncoder.d.ts:41

tryDecode

tryDecode(recipientPublicKey, encodedMessage): TryDecodeResult
Tries to decode encoded message.
Parameters
- recipientPublicKey: PublicKey
  Recipient public key.
- encodedMessage: Message
  Encoded message.
Returns TryDecodeResult
Tuple containing decoded status and message.
- Defined in nem/MessageEncoder.d.ts:25