Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SendMediaMessageParams<T>

Base parameters for sending a media message (file, image, voice, etc.) that requires file upload.

example
const params = new SendImageMessageParams({ remoteUrl: '', thumbnailBase64: '' });
params.file = imageFile;
params.onUploadProgress = (progress, msg) => {
  console.log(`Upload progress: ${progress}%`);
};
await channel.sendMediaMessage(params);

Type Parameters

  • T extends Record<string, any>

    The type of the message content

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<T>) => void)

Type declaration

    • Callback invoked before the message is sent, providing the local message instance

      Parameters

      Returns void

Optional file

file?: File

The file to upload

Optional onUploadProgress

onUploadProgress?: ((progress: number, message: Message<T>) => void)

Type declaration

    • (progress: number, message: Message<T>): void

    • Callback invoked during upload with progress percentage (0-100)

      Parameters

      • progress: number
      • message: Message<T>

      Returns void

Optional onUploadComplete

onUploadComplete?: ((remoteUrl: string, message: Message<T>) => void)

Type declaration

    • (remoteUrl: string, message: Message<T>): void

    • Callback invoked when the upload completes successfully

      Parameters

      • remoteUrl: string
      • message: Message<T>

      Returns void

Optional onUploadError

onUploadError?: ((code: number, message: Message<T>) => void)

Type declaration

    • (code: number, message: Message<T>): void

    • Callback invoked when the upload fails

      Parameters

      Returns void

Constructors

constructor