new ChatroomMessage()
聊天室消息
- 'in'表示此消息是收到的消息
- 'out'表示此消息是发出的消息
- 推荐使用
JSON
格式构建, 非JSON
格式的话, Web端会正常接收, 但是会被其它端丢弃
Properties:
Name | Type | Argument | Description |
---|---|---|---|
chatroomId |
String | 聊天室 ID |
|
idClient |
String | SDK生成的消息id, 在发送消息之后会返回给开发者, 开发者可以在发送消息的结果回调里面根据这个ID来判断相应消息的发送状态, 到底是发送成功了还是发送失败了, 然后根据此状态来更新页面的UI。如果发送失败, 那么可以重新发送此消息 |
|
from |
String | 消息发送方, 帐号 |
|
fromNick |
String | 消息发送方的昵称 |
|
fromAvatar |
String | 消息发送方的头像 |
|
fromCustom |
String | 消息发送方的扩展字段 |
|
fromClientType |
String | 发送方的 |
|
type |
String | ||
flow |
String | 消息的流向 |
|
text |
String |
<optional> |
文本消息的文本内容, 请参考 |
file |
Object |
<optional> |
|
geo |
Object |
<optional> |
地理位置消息的 |
tip |
String |
<optional> |
提醒消息的内容, 请参考 |
content |
String |
<optional> |
自定义消息的消息内容, 开发者可以自行扩展, 建议封装成JSON格式字符串, 请参考 |
attach |
Object |
<optional> |
|
custom |
String |
<optional> |
扩展字段 |
resend |
Boolean | 是否是重发的消息 |
|
time |
Number | 时间戳 |
Members
-
static,readonlyChatroomMessage.attach.typeString
-
聊天室通知消息的类型
- 聊天室通知消息是
聊天室消息
的一种, 请参考聊天室消息类型
, 某些聊天室操作后所有聊天室成员会收到一条相应的聊天室通知消息 - 聊天室通知消息有一个字段
attach
包含了额外的信息,attach
有一个字段type
来标识聊天室通知消息的类型memberEnter
- 当有人进入聊天室时, 所有聊天室成员会收到类型为
的'memberEnter'
聊天室通知消息
。
- 当有人进入聊天室时, 所有聊天室成员会收到类型为
memberExit
- 当有人退出聊天室时, 所有聊天室成员会收到类型为
的'memberExit'
聊天室通知消息
。
- 当有人退出聊天室时, 所有聊天室成员会收到类型为
addManager
- 当有人被
加为管理员
时, 所有聊天室成员会收到类型为
的'addManager'
聊天室通知消息
。
- 当有人被
removeManager
- 当有人被
移除管理员
时, 所有聊天室成员会收到类型为
的'removeManager'
聊天室通知消息
。
- 当有人被
addCommon
- 当有人被
加为普通成员
时, 所有聊天室成员会收到类型为
的'addCommon'
聊天室通知消息
。
- 当有人被
removeCommon
- 当有人被
移除普通成员
时, 所有聊天室成员会收到类型为
的'removeCommon'
聊天室通知消息
。
- 当有人被
blackMember
- 当有人被
加入黑名单
时, 所有聊天室成员会收到类型为
的'blackMember'
聊天室通知消息
。
- 当有人被
unblackMember
- 当有人被
移除黑名单
时, 所有聊天室成员会收到类型为
的'blackMember'
聊天室通知消息
。
- 当有人被
gagMember
- 当有人被
加入禁言名单
时, 所有聊天室成员会收到类型为
的'gagMember'
聊天室通知消息
。
- 当有人被
ungagMember
- 当有人被
移除禁言名单
时, 所有聊天室成员会收到类型为
的'ungagMember'
聊天室通知消息
。
- 当有人被
kickMember
- 当有人被
踢出聊天室
时, 所有聊天室成员会收到类型为
的'kickMember'
聊天室通知消息
。
- 当有人被
updateChatroom
- 当
更新聊天室信息
时, 所有聊天室成员会收到类型为
的'updateChatroom'
聊天室通知消息
。
- 当
updateMemberInfo
- 当
更新自己在聊天室内的信息
时, 所有聊天室成员会收到类型为
的'updateMemberInfo'
聊天室通知消息
。
- 当
addTempMute
removeTempMute
- 当有人被
设置聊天室临时禁言
时,所有聊天室成员会收到类型为
的'addTempMute' or 'removeTempMute'
聊天室通知消息
。
- 当有人被
muteRoom
聊天室被禁言了,只有管理员可以发言,其他人都处于禁言状态unmuteRoom
聊天室解除全体禁言状态
attach
的字段from
为操作方的账号,fromNick
为操作方的昵称,to
为被操作方的账号,toNick
为被操作方的昵称- 如果是
addTempMute
,attach
的字段duration
代表本次禁言的时长 - 如果是
removeTempMute
,attach
的字段duration
代表解禁提前的时长
- 如果是
- 聊天室通知消息是
-
static,readonlyChatroomMessage.typeString
-
聊天室消息类型
'text'
(文本)'image'
(图片)'audio'
(音频)'video'
(视频)'file'
(文件)'geo'
(地理位置)'custom'
(自定义消息)'tip'
(提醒消息)- 提醒消息用于会话内的状态提醒,如进入会话时出现的欢迎消息,或者会话命中敏感词后的提示消息等等.
'notification'
(聊天室通知消息)- 某些聊天室操作后所有聊天室成员会收到一条相应的聊天室通知消息, 详细介绍请参考
聊天室通知消息的类型
- 某些聊天室操作后所有聊天室成员会收到一条相应的聊天室通知消息, 详细介绍请参考