Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

body?: { filename: string; type: string; url: string }

The message body.

Type declaration

  • filename: string

    The file name.

  • type: string

    The file type.

  • url: string

    The file URL.

chatType: ChatType

The session type.

deliverOnlineOnly?: boolean

Whether the message is delivered only when the recipient(s) is/are online:

  • true: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is discarded.
  • (Default) false: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.
ext?: {}

The message extension.

Type declaration

  • [key: string]: any
file: FileObj

The file object.

fileInputId?: string

The input ID of the file to be uploaded.

file_length?: number

The size of the file.

filename?: string

The file name.

from?: string

The sender, which can only be the current user and can not be changed.

group?: string
deprecated

Whether the session type is group.

id: string

The message ID.

isChatThread?: boolean

Whether the message is a thread message.

msgConfig?: { allowGroupAck: boolean }

Whether read receipts are required during a group session.

Type declaration

  • allowGroupAck: boolean
priority?: MessagePriority

Message priority.

receiverList?: string[]

The list of message recipients.

roomType?: boolean
deprecated

Whether the session type is chat room.

time: number

Time.

to: string

The recipient.

type: "file"

The message type.

Methods

  • fail(): void
  • The callback for a message sending failure.

    Returns void

  • onFileUploadComplete(data: any): void
  • onFileUploadError(error: any): void
  • onFileUploadProgress(data: any): void

Generated using TypeDoc