Interface SendMessageArgs

The argument object for MessageApi.sendMessage

Param: message

The message as text to be sent

Param: messageIsText

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

Param: recipientId

The id of the recipient

Param: recipientPublicKey

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

interface SendMessageArgs {
    attachment?: Attachment;
    deadline?: number;
    feePlanck: string;
    message: string;
    messageIsText?: boolean;
    recipientId: string;
    recipientPublicKey?: string;
    referencedTransactionFullHash?: string;
    senderPrivateKey?: string;
    senderPublicKey: string;
    skipAdditionalSecurityCheck?: boolean;
}

Hierarchy

  • DefaultSendArgs
    • SendMessageArgs

Properties

attachment? deadline? feePlanck message messageIsText? recipientId recipientPublicKey? referencedTransactionFullHash? senderPrivateKey? senderPublicKey skipAdditionalSecurityCheck?

Properties

Optionalattachment

attachment?: Attachment

An optional attachment

Optionaldeadline

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

It's recommended to use util.Amount

message

message: string

OptionalmessageIsText

messageIsText?: boolean

recipientId

recipientId: string

OptionalrecipientPublicKey

recipientPublicKey?: string

OptionalreferencedTransactionFullHash

referencedTransactionFullHash?: string

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

OptionalsenderPrivateKey

senderPrivateKey?: string

The senders private key, i.e. the crypto.SignKeys.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.SignKeys.publicKey

OptionalskipAdditionalSecurityCheck

skipAdditionalSecurityCheck?: boolean

Setting this option to true, skips the additional security check, i.e. the verification of the unsigned transaction bytes, which detects tampered node responses. By default, the option is false. Usually, you won't use this option, but can be useful when a method cannot be verified, because the verification is not implemented yet.

Settings

Member Visibility

On This Page

Properties