聊天室属性管理
更新时间:2022-02-28
聊天室属性管理指管理聊天室的属性信息。
技术原理
环信即时通讯 IM SDK 提供以下方法支持对聊天室的属性管理:
getChatRoomDetails
获取聊天室详情;modifyChatRoom
更新聊天室详情;fetchChatRoomAnnouncement
获取聊天室公告;updateChatRoomAnnouncement
修改聊天室公告。
前提条件
实现方法
获取聊天室详情
聊天室所有成员可以通过该接口获取聊天室详情。
注意
- 聊天室创建者、管理员和普通成员可调用该接口。
- 聊天室详情包括聊天室主题、公告、描述、成员类型、管理员列表、当前聊天人数和聊天室最大成员数等。
示例代码如下:
let option = {
chatRoomId: 'chatRoomId'
}
conn.getChatRoomDetails(option).then(res => console.log(res))
更新聊天室详情
聊天室所有者和管理员可以更新聊天室详情,群成员可以获取聊天室详情。
示例代码如下:
let option = {
chatRoomId: 'chatRoomId',
chatRoomName: 'chatRoomName', // 聊天室名称。
description: 'description', // 聊天室描述。
maxusers: 200 // 聊天室最大成员数。
}
conn.modifyChatRoom(option).then(res => console.log(res))
获取聊天室公告
聊天室所有者和管理员可以设置和更新群公告,群成员可以获取群公告。
示例代码如下:
var option = {
roomId: 'roomId'
};
conn.fetchChatRoomAnnouncement(option).then(res => console.log(res))
修改聊天室公告
聊天室所有者和管理员可以设置和更新群公告。
注意
- 仅聊天室所有者和管理员可调用该接口;
- 成员仅当前在聊天室中才能收到通知;
- 聊天室所有者或者管理员修改聊天室公告时,其它成员会收到
updateAnnouncement
监听事件。
示例代码如下:
let option = {
roomId: 'roomId',
announcement: 'hello everyone'
};
conn.updateChatRoomAnnouncement(option).then(res => console.log(res))