Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SendMessageArgs

The argument object for MessageApi.sendMessage

param

The message as text to be sent

param

Defines whether the message is text or another format (hex or base64) (default: true)

param

The id of the recipient

param

The optional recipients public key in hex format. Using this arg allows to activate a recipients account, if not activated yet

Hierarchy

Index

Properties

Optional attachment

attachment: Attachment

An optional attachment

Optional deadline

deadline: number

The deadline when after how many minutes the transaction will be discarded, if it was not processed, e.g. due to very low fee

feePlanck

feePlanck: string

The fee expressed in Planck

note

It's recommended to use util.Amount

message

message: string

Optional messageIsText

messageIsText: boolean

recipientId

recipientId: string

Optional recipientPublicKey

recipientPublicKey: string

Optional referencedTransactionFullHash

referencedTransactionFullHash: string

Using this field allows to make a transaction dependent on other transactions.

Optional senderPrivateKey

senderPrivateKey: string

The senders private key, i.e. the crypto.Keys.signPrivateKey If the private key is not given, then the transaction method will return the unsigned byte string. The transaction won't be processed until the unsigned bytes are being signed and broadcasted using TransactionApi.signAndBroadcastTransaction

senderPublicKey

senderPublicKey: string

The senders public key, i.e. the crypto.Keys.publicKey