Interface MessageApi

The Message API

interface MessageApi {
sendEncryptedMessage: ((args: SendEncryptedMessageArgs) => Promise<TransactionId | UnsignedTransaction>);
sendMessage: ((args: SendMessageArgs) => Promise<TransactionId | UnsignedTransaction>);
}

Index

Properties

sendEncryptedMessage sendMessage

Properties

sendEncryptedMessage

sendEncryptedMessage: ((args: SendEncryptedMessageArgs) => Promise<TransactionId | UnsignedTransaction>)

Sends an encrypted text message to another account/recipient

Type declaration

- (args): Promise<TransactionId | UnsignedTransaction>
- Parameters
  - args: SendEncryptedMessageArgs
    The argument object
  Returns Promise<TransactionId | UnsignedTransaction>
  The Transaction Id or Unsigned Bytes as Hex String if no private key was sent

sendMessage

sendMessage: ((args: SendMessageArgs) => Promise<TransactionId | UnsignedTransaction>)

Sends a plain text message to another account/recipient

Type declaration

- (args): Promise<TransactionId | UnsignedTransaction>
- Parameters
  - args: SendMessageArgs
    The argument object
  Returns Promise<TransactionId | UnsignedTransaction>
  The Transaction Id or Unsigned Bytes as Hex String if no private key was sent