Documentation

Class: ChatroomMessage

ChatroomMessage

new ChatroomMessage()

聊天室消息

Properties:
Name Type Argument Description
chatroomId String

聊天室 ID
idClient String

SDK生成的消息id, 在发送消息之后会返回给开发者, SDK生成的消息id, 在发送消息之后会返回给开发者, 作为消息的不重复的key值
from String

消息发送方, 帐号
fromNick String

消息发送方的昵称
fromAvatar String

消息发送方的头像
fromCustom String

消息发送方的扩展字段
fromClientType String

发送方的设备类型
type String

消息类型
flow String

消息的流向

  • 'in'表示此消息是收到的消息
  • 'out'表示此消息是发出的消息
skipHistory Boolean <optional>

是否跳过存云端历史, false:不跳过,true:跳过存历史,默认false
text String <optional>

文本消息的文本内容, 请参考发送聊天室文本消息
file Object <optional>

文件消息的文件对象, 具体字段请参考图片对象、音频对象、视频对象和文件对象, 请参考发送聊天室文件消息
geo Object <optional>

地理位置消息的地理位置对象, 请参考发送聊天室地理位置消息
tip String <optional>

提醒消息的内容, 请参考发送聊天室提醒消息
content String <optional>

自定义消息的消息内容, 开发者可以自行扩展, 建议封装成JSON格式字符串, 请参考发送聊天室自定义消息
attach Object <optional>

聊天室通知消息的附加信息,
参考聊天室通知消息的类型来查看详细解释
custom String <optional>

扩展字段

  • 推荐使用JSON格式构建, 非JSON格式的话, Web端会正常接收, 但是会被其它端丢弃
resend Boolean

是否是重发的消息
time Number

时间戳
callbackExt String

服务器第三方回调的扩展字段
subType Integer

开发者自定义的消息子类型，格式为大于0的整数
env String

环境变量，用于指向不同的抄送、第三方回调等配置

Members

<static, readonly> type :String

聊天室消息类型

  • 'text' (文本)
  • 'image' (图片)
  • 'audio' (音频)
  • 'video' (视频)
  • 'file' (文件)
  • 'geo' (地理位置)
  • 'custom' (自定义消息)
  • 'robot' (机器人消息)
  • 'tip' (提醒消息)
    • 提醒消息用于会话内的状态提醒，如进入会话时出现的欢迎消息，或者会话命中敏感词后的提示消息等等.
  • 'notification' (聊天室通知消息)
Type:
  • String