Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

apiUrl?: string

文件上传地址。

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

消息体。

Type declaration

  • filename: string

    文件名。

  • type: string

    文件类型。

  • url: string

    文件 URL。

broadcast?: boolean

判断是否是全局广播消息。

chatType: ChatType

会话类型。

deliverOnlineOnly?: boolean

消息是否只投递给在线用户:

  • true: 只有消息接收方在线时才能投递成功。若接收方离线,则消息会被丢弃。
  • (默认)false: 如果用户在线,则直接投递;如果用户离线,消息会在用户上线时投递。
ext?: {}

消息扩展。

Type declaration

  • [key: string]: any
file: FileObj

文件对象。

fileInputId?: string

上传文件的 input ID。

file_length?: number

音频文件大小。

filename: string

文件名。

from?: string

消息发送方,只能是当前用户,无法修改。

group?: string

是否是群聊。

id: string

消息 ID。

isChatThread?: boolean

消息是否为子区消息

isContentReplaced?: boolean

消息内容是否已被替换。该属性仅在初始化时开启 useReplacedMessageContent 后有效。

length?: number

音频时长。

msgConfig?: { allowGroupAck: boolean }

群组会话时是否需返回已读回执。

Type declaration

  • allowGroupAck: boolean
priority?: MessagePriority

消息优先级

receiverList?: string[]

消息接收方列表。

roomType?: boolean
deprecated

会话类型是否是聊天室。

time: number

时间。

to: string

消息的接收方。

type: "audio"

消息类型。

Methods

  • fail(): void
  • onFileUploadComplete(data: any): void
  • onFileUploadError(err: any): void
  • onFileUploadProgress(data: ProgressEvent<EventTarget>): void

Generated using TypeDoc