全部文档

更新时间: 2020-09-01

可在指定聊天室中设置自定义属性，用于语音直播聊天室场景的会场属性同步或狼人杀等卡牌类游戏场景中记录用户的角色和牌局状态等。

  1. 每个聊天室中，最多允许设置 100 个属性信息，以 Key-Value 的方式进行存储。
  2. 每个聊天室中，每秒钟最多允许操作 Key-Value 100 次。
  3. 聊天室销毁后，聊天室中的自定义属性同时销毁。
  4. 使用此功能需要在开发者后台免费基础功能中开通 聊天室属性自定义设置 (opens new window)功能。

实现此功能需要开发者实现 RongIMClient 的对应回调

# 参数说明

回调方法参数说明：

参数 类型 说明
roomId String 聊天室 ID
entry Map 修改或者删除的 KV 字典

# 代码示例

//聊天室 kv 同步完成
RongIMClient.chatRoomKVDidSync = (String roomId) {
    DialogUtil.showAlertDiaLog(context, "chatRoomKVDidSync $roomId ");
};

//聊天室 kv 有更新
RongIMClient.chatRoomKVDidUpdate = (String roomId, Map entry) {
    DialogUtil.showAlertDiaLog(context, "chatRoomKVDidUpdate $roomId $entry");
};

//聊天室 kv 有删除
RongIMClient.chatRoomKVDidRemove = (String roomId, Map entry) {
    DialogUtil.showAlertDiaLog(context, "chatRoomKVDidRemove $roomId $entry");
};

已复制
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 设置属性

设置聊天室自定义属性，当 key 不存在时，代表增加属性； 当 key 已经存在时，代表更新属性的值，且只有 key 的创建者可以更新属性的值。

# 参数说明

输入参数说明

参数 类型 必填 说明
chatroomId String 是 聊天室的 chatroomId
key String 是 聊天室属性名称，Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 128 个字符
value String 是 聊天室属性对应的值，最大长度 4096 个字符
sendNotification BOOL 是 是否需要发送通知，
autoDelete BOOL 是 用户掉线或退出时，是否自动删除该 Key、Value 值；自动删除时不会发送通知
notificationExtra String 是 通知的自定义字段，RC:chrmKVNotiMsg 通知消息中会包含此字段，最大长度 2 kb

返回参数说明

回调参数 回调类型 说明
code RCErrorCode 获取失败的错误码
# 代码示例
RongIMClient.setChatRoomEntry(
    targetId, "key1", "value1", true, true, "notificationExtra",
    (int code) {
    DialogUtil.showAlertDiaLog(context,
        "设置 KV: {key1: value1}, 发送通知, 退出时删除, code: " + CodeUtil.codeString(code));
});

已复制
1
2
3
4
5
6

# 强制设置属性

强制设置聊天室自定义属性，当 key 不存在时，代表增加属性； 当 key 已经存在时，代表更新属性的值。

# 参数说明

输入参数说明

参数 类型 必填 说明
chatroomId String 是 聊天室的 chatroomId
key String 是 聊天室属性名称，Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 128 个字符
value String 是 聊天室属性对应的值，最大长度 4096 个字符
sendNotification BOOL 是 是否需要发送通知，
autoDelete BOOL 是 用户掉线或退出时，是否自动删除该 Key、Value 值；自动删除时不会发送通知
notificationExtra String 是 通知的自定义字段，RC:chrmKVNotiMsg 通知消息中会包含此字段，最大长度 2 kb

返回参数说明

回调参数 回调类型 说明
code RCErrorCode 获取失败的错误码
# 代码示例
RongIMClient.forceSetChatRoomEntry(
        targetId, "key2", "value2", false, false, "notificationExtra",
        (int code) {
      DialogUtil.showAlertDiaLog(
          context,
          "强制删除 KV: {key2: value2}, 不发送通知, 退出时不删除，code: " +
              CodeUtil.codeString(code));
    });

已复制
1
2
3
4
5
6
7
8

# 删除属性

删除聊天室自定义属性，只有自己设置的属性可以被删除。

# 参数说明

输入参数说明

参数 类型 必填 说明
chatroomId String 是 聊天室的 chatroomId
key String 是 聊天室属性名称，Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 128 个字符
sendNotification BOOL 是 是否需要发送通知
notificationExtra String 是 通知的自定义字段，RC:chrmKVNotiMsg 通知消息中会包含此字段，最大长度 2 kb

返回参数说明

回调参数 回调类型 说明
code RCErrorCode 获取失败的错误码
# 代码示例

只有自己设置的属性可以被删除。

RongIMClient.removeChatRoomEntry(
    targetId, "key1", true, "notificationExtra", (int code) {
    DialogUtil.showAlertDiaLog(
        context, "删除 KV: key1, 发送通知, code: " + CodeUtil.codeString(code));
});

已复制
1
2
3
4
5

# 强制删除属性

强制删除聊天室自定义属性。

# 参数说明

输入参数说明

参数 类型 必填 说明
chatroomId String 是 聊天室的 chatroomId
key String 是 聊天室属性名称，Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 128 个字符
sendNotification BOOL 是 是否需要发送通知
notificationExtra String 是 通知的自定义字段，RC:chrmKVNotiMsg 通知消息中会包含此字段，最大长度 2 kb

返回参数说明

回调参数 回调类型 说明
code RCErrorCode 获取失败的错误码，0 代表操作成功
# 代码示例
RongIMClient.forceRemoveChatRoomEntry(
    targetId, "key2", false, "notificationExtra", (int code) {
    DialogUtil.showAlertDiaLog(
        context, "强制删除 KV: key2, 不发送通知, code: " + CodeUtil.codeString(code));
});

已复制
1
2
3
4
5

# 获取单个属性

# 参数说明

输入参数说明

参数 类型 必填 说明
chatroomId String 是 聊天室的 chatroomId
key String 是 聊天室属性名称，

返回参数说明

回调参数 回调类型 说明
entry Map 属性内容
status RCErrorCode 获取失败的错误码，0 代表操作成功
# 代码示例
RongIMClient.getChatRoomEntry(targetId, "key1", (Map entry, int code) {
    DialogUtil.showAlertDiaLog(context,
        "获取单个 KV: key1, code: " + CodeUtil.codeString(code) + ", entry: $entry");
});

已复制
1
2
3
4

# 获取所有属性

# 参数说明

输入参数说明

参数 类型 必填 说明
chatroomId String 是 聊天室的 chatroomId

返回参数说明

回调参数 回调类型 说明
entry Map 属性内容
status RCErrorCode 获取失败的错误码
# 代码示例
RongIMClient.getAllChatRoomEntries(targetId, (Map entry, int code) {
    DialogUtil.showAlertDiaLog(context,
        "获取所有 KV: code: " + CodeUtil.codeString(code) + ", entry: $entry");
});

已复制
1
2
3
4

文档是否解决您的问题 ?

如果遇到产品相关问题，您可 提交工单 寻求帮助