Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

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

消息体。

Type declaration

  • filename: string

    文件名。

  • type: string

    文件类型。

  • url: string

    文件 URL。

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

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

isChatThread?: boolean

消息是否为子区消息

msgConfig?: { allowGroupAck: boolean }

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

Type declaration

  • allowGroupAck: boolean
priority?: MessagePriority

消息优先级

receiverList?: string[]

消息接收方列表。

to: string

消息的接收方。

type: "file"

消息类型。

Methods

  • onFileUploadComplete(data: any): void
  • 文件上传完成的回调。

    Parameters

    • data: any

    Returns void

  • onFileUploadError(error: any): void
  • 文件上传错误的回调。

    Parameters

    • error: any

    Returns void

  • onFileUploadProgress(data: any): void
  • 文件上传进度的回调。

    Parameters

    • data: any

    Returns void

Generated using TypeDoc