Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IReceivedMessage

从服务端接收到的消息数据

Hierarchy

  • IReceivedMessage

Index

Properties

Properties

Optional channelId

channelId?: string

会话的业务标识

conversationType

conversationType: ConversationType

会话类型

  • 1: 单聊
  • 3: 群聊
  • 4: 聊天室
  • 5: 客服会话
  • 6: 系统消息
  • 7: 默认关注的公众号
  • 8: 手动关注的公众号
  • 9: RTCLib 房间

targetId

targetId: string

会话 targetId

senderUserId

senderUserId: string

消息发送者的用户 Id

content

content: any

消息内容

messageType

messageType: string

消息结构名称，即消息类型

example

RC:TxtMsg

messageUId

messageUId: string

服务端存储的消息 Id

messageDirection

messageDirection: MessageDirection

消息方向是发出 or 收取

isOffLineMessage

isOffLineMessage: boolean

是否为离线消息, 在超级群中不适用

sentTime

sentTime: number

消息在服务器端的发送时间

receivedTime

receivedTime: number

消息接收时间，该时间通过消息的 sentTime 值在本地进行计算得出，不推荐使用

description

当 isOffLineMessage 为 true 时，该值无效

isPersited

isPersited: boolean

是否存储

defaultvalue

true

isCounted

isCounted: boolean

是否计数

defaultvalue

true

isMentioned

isMentioned: boolean

是否为 @ 消息

disableNotification

disableNotification: boolean

消息是否静默

description

静默消息不会发送 Push 信息和本地通知提醒

isStatusMessage

isStatusMessage: boolean

是否是状态消息

canIncludeExpansion

canIncludeExpansion: boolean

是否支持消息扩展存储

expansion

expansion: null | {}

消息携带的扩展存储

receivedStatus

receivedStatus: number

消息接收状态 只能表示单一状态，推荐使用 receivedStatusInfo 来判断接收消息状态

deprecated

Optional receivedStatusInfo

receivedStatusInfo?: IReceivedStatusInfo

消息接收状态详情 推荐使用, receivedStatusInfo 值更详细，能同时表示多个接收状态

Optional messageId

messageId?: number

消息本地 ID, web 端由 lib 内生成， PC 端由协议栈数据库生成自增ID

Optional sentStatus

sentStatus?: SentStatus

消息发送状态， web 端由 lib 内根据消息状态设置值为 发送中、已发送和发送失败 ，PC 端由协议栈自动维护或用户自己设置

Optional readReceiptInfo

readReceiptInfo?: IReadReceiptInfo | IReadReceiptResponseInfo

群已读回执信息(导航配置 grpRRVer = 0 时为 IReadReceiptResponseInfo， grpRRVer >= 1时为 IReadReceiptInfo)

Optional pushConfig

pushConfig?: IPushConfig

推送扩展

Optional isInterrupt

isInterrupt?: boolean

超级群专有字段，是否断档，服务端收到大量消息可能会断档，所以消息存在此标志位，断档需要客户手动拉取历史消息

Optional isModifyMessage

isModifyMessage?: boolean

拉取历史消息时表示该消息是否修改过（仅超级群有效）

Optional channelType

channelType?: UltraGroupChannelType

拉取历史消息时表示该消息是否为超级群频道类型（仅超级群有效）

Optional hasMore

hasMore?: boolean

是否断档

Optional directedUserIds

directedUserIds?: string[]

定向用户列表(仅支持群聊, 超级群)