跳到主要内容

版本:2.X

删除属性

删除属性

仅能删除自己设置的聊天室属性

API 参考:removeChatroomEntry

参数说明

参数类型必填说明最低版本
chatRoomIdString聊天室 ID2.5.3
chatroomEntryObject设置的属性信息2.5.3

chatroomEntry 说明:

参数类型必填说明最低版本
keyString属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符2.5.3
isSendNotificationBoolean删除成功后是否发送通知消息2.5.3
notificationExtraStringRC:chrmKVNotiMsg 消息中携带的附加信息2.5.3

代码示例

var chatRoomId = 'chatroom1';
var key = 'role';
var chatroomEntry = {
key: key,
isSendNotification: true,
notificationExtra: 'Change role'
};
RongIMClient.getInstance().removeChatroomEntry(chatRoomId, chatroomEntry, {
onSuccess: function() {
console.log('删除聊天室属性成功');
},
onError: function(error) {
// 请检查: 是否开通聊天室属性自定义服务
console.log('删除聊天室属性失败', error);
}
});

强制删除属性

强制删除任意聊天室属性

API 参考:forceRemoveChatroomEntry

参数说明

参数类型必填说明最低版本
chatRoomIdString聊天室 ID2.5.3
chatroomEntryObject设置的属性信息2.5.3

chatroomEntry 说明:

参数类型必填说明最低版本
keyString属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符2.5.3
isSendNotificationBoolean删除成功后是否发送通知消息2.5.3
notificationExtraStringRC:chrmKVNotiMsg 消息中携带的附加信息2.5.3

代码示例

var chatRoomId = 'chatroom1';
var key = 'role';
var chatroomEntry = {
key: key,
isSendNotification: true,
notificationExtra: 'Change role'
};
RongIMClient.getInstance().forceRemoveChatroomEntry(chatRoomId, chatroomEntry, {
onSuccess: function() {
console.log('强制删除聊天室属性成功');
},
onError: function(error) {
// 请检查: 是否开通聊天室属性自定义服务
console.log('强制删除聊天室属性失败', error);
}
});