Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SendTextMessageParams

Parameters for sending a text message.

example
const params = new SendTextMessageParams({ text: 'Hello!' });
await channel.sendMessage(params);

Hierarchy

Index

Accessors

Properties

Constructors

Accessors

content

  • get content(): T

  • The message content payload

    Returns T

messageType

  • get messageType(): string

  • The registered message type identifier (e.g. 'RC:TxtMsg')

    Returns string

Properties

Optional directedUserIds

directedUserIds?: string[]

List of target user IDs for directed messages. Only these users will receive the message.

Optional disableNotification

disableNotification?: boolean

If true, suppress push notifications for this message

Optional disableUpdateLastMessage

disableUpdateLastMessage?: boolean

If true, this message will not update the channel's last message

Optional needReceipt

needReceipt?: boolean

If true, request read receipt for this message

Optional metadata

metadata?: Record<string, string>

Key-value metadata (expansion) to attach to the message

Optional pushConfig

pushConfig?: PushConfig

Push notification configuration for this message

Optional onSendBefore

onSendBefore?: ((message: Message<TextMessageContent>) => void)

Type declaration

Constructors

constructor