Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • QChatMessage

Index

Properties

accidsOfMentionedRoles?: string[]

被艾特的身份组的成员的账号列表

注: 小 server 场景下,IM 服务端会直接计算得到艾特的身份组下包含的成员, 用于做被艾特的未读数更新, 开发者并不需要关心.

反垃圾相关字段

附加内容,type 为 custom,image,video,audio,file,geo 等类型都会附带这个

其中 image,video,audio,file 作为文件类型,返回值是 UploadFileResult

而 geo 的返回是 QChatMessageForGEOAttach

而 custom 的返回一个可以随意 key-value 的对象

body?: string

消息的内容,type 为 text,tip 时有此值,其他的类型不一定有。

callbackExt?: string

抄送相关-第三方回调扩展字段

channelId: string

消息所属的频道的id

deliveryStatus?: "sending" | "success" | "failed"

消息的送达状态,区分发送中,发送失败,发送成功三种。

env?: string

抄送相关-环境变量

注:开发者可以根据不同的 env 配置不同的抄送和回调地址。仅当 routeEnable 为 true 时生效

ext?: string

扩展字段

fromAccount: string

消息发送方, 帐号

fromClientType?: "Android" | "iOS" | "PC" | "WindowsPhone" | "Web" | "Server" | "Mac"

发送方的设备类型

fromDeviceId?: string

发送端设备id

fromNick?: string

消息发送方的昵称

historyEnable?: boolean

是否存云端消息历史,缺省则 true

isAntispam?: boolean

是否触发反垃圾,而被拦截。默认 false

mentionAccids?: string[]

被 “艾特” 的人的 account id 列表

mentionAll?: boolean

是否 “艾特” 了所有人

mentionRoleIds?: string[]

被艾特的身份组的 roleId 列表

注: 大 server 的场景下, IM 服务端返回这个这个用于判定收到消息的账号是否包含在被艾特的身份组成员中, 来做被艾特的未读数更新, 开发者并不需要关心.

msgIdClient: string

SDK 端测生成的消息id,消息唯一凭证,主键

msgIdServer: string

IM 服务端生成的消息 id,如果消息发送成功,服务器将会赋予这个值.

注意:不要和上面的 serverId 概念混起来

needBadge?: boolean

开关位-推送相关:是否需要消息计数(APP 的角标计数)

needPushNick?: boolean

开关位-推送相关:是否需要推送昵称

notifyReason?: "notifyAll" | "notifySubscribe"

下发通知的原因

pushContent?: string

移动端 APP 推送相关-推送内容

pushEnable?: boolean

开关位-推送相关:是否开启推送

注意:该参数设置作用于服务器推送给移动端设备,JS SDK 只作设置

pushPayload?: StrAnyObj

移动端 APP 推送相关-推送属性

replyRefer?: QChatMessageRefer

“回复消息”的引用

resendFlag?: boolean

是否为重发的消息

routeEnable?: boolean

开关位-抄送相关:消息是否需要抄送。

默认为 true

serverId: string

消息所属的服务器的id

status?: number

消息的状态

0: 一般状态,默认。 1: 被撤回。 2: 被删除。 大于 10000 ,用户自定义。

subType?: number

消息子类型

threadRefer?: QChatMessageRefer

”thread 根消息“引用

time: number

消息发送成功的时间戳(单位毫秒)

type: "text" | "image" | "audio" | "video" | "geo" | "notification" | "file" | "tip" | "robot" | "g2" | "custom"

消息类型

updateContent?: { body?: string; ext?: string; status?: number }

消息在上次更新后的内容,当消息曾被更新过/删除过/撤回过时存在。

Type declaration

  • Optional body?: string

    消息更新后的 body 内容

    注,存在条件为:若消息更新时,有 body 的变动。

  • Optional ext?: string

    消息更新后的 ext 内容

    注,存在条件为:若消息更新时,有 ext 的变动。

  • Optional status?: number

    消息更新后的状态,定义同上文的 status

    注,存在条件为:撤回,删除,或者更新消息为自定义状态。

updateOperatorInfo?: QChatMessageUpdateOperatorInfo

消息在上次更新后的操作信息

updateTime: number

最后更新时间