更新时间: 2021-03-08

# 删除属性

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

# 参数说明

输入参数说明

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

返回参数说明

error 说明:

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

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

[[RCIMClient sharedRCIMClient] removeChatRoomEntry:chatroomId
                                                key:key
                                  sendNotification:isNotice
                                  notificationExtra:extra
                                            success:^{} 
                                              error:^(RCErrorCode nErrorCode) {}];
已复制
1
2
3
4
5
6

# 强制删除属性

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

# 参数说明

输入参数说明

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

返回参数说明

error 说明:

回调参数 回调类型 说明
status RCErrorCode 获取失败的错误码
# 代码示例
[[RCIMClient sharedRCIMClient] forceRemoveChatRoomEntry:chatroomId
                                                    key:key
                                        sendNotification:isNotice
                                      notificationExtra:extra
                                                success:^{}
                                                  error:^(RCErrorCode nErrorCode) {}];
已复制
1
2
3
4
5
6

# 批量删除属性

批量删除聊天室自定义属性。

# 参数说明

输入参数说明

参数 类型 必填 说明
chatroomId NSString 聊天室的 chatroomId
keys NSArray 聊天室属性名称,最多一次删除 10 条
isForce BOOL 是否强制覆盖
successBlock Block - 成功的回调
errorBlock Block - 失败的回调

返回参数说明

error 说明:

回调参数 回调类型 说明
nErrorCode RCErrorCode 获取失败的错误码
entries NSDictionary 当 nErrorCode 为 RC_KV_STORE_NOT_ALL_SUCCESS(23428)的时候,entries 才会有值(key 为设置失败的 key,value 为该 key 对应的错误码)
# 代码示例
[[RCChatRoomClient sharedChatRoomClient] removeChatRoomEntries:chatroomId
                                                          keys:keys
                                                        isForce:isForce
                                                        success:^{ }
                                                          error:^(RCErrorCode nErrorCode, NSDictionary * _Nonnull entries) { }];
已复制
1
2
3
4
5

文档是否解决您的问题 ?

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