getJoinedGroupList
功能介绍
获取当前用户已经加入的群组
直播群(AVChatRoom)和 社群(Community,支持话题的社群)不包含在此列表中。
该接口有频限检测,SDK 限制调用频率为1 秒 10 次,超过限制后会报 ERR_SDK_COMM_API_CALL_FREQUENCY_LIMIT (7008)错误
若查询的群组为工作群(Work),需要此群先存在发送的消息将群激活才能查询到。
参数详解
此API无参数
返回模板
V2TimValueCallback<V2TimGroupInfo[]>
{
code : number
desc : string
data : V2TimGroupInfo[]
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | number | 请求结果错误码 |
desc | string | 请求结果描述符 |
data | V2TimGroupInfo[] | 查询到的群组列表 |
代码示例
import { TencentImSDKPlugin } from 'react-native-tim-js';
//获取当前用户已经加入的群列
const getJoinedGroupListRes = await TencentImSDKPlugin.v2TIMManager
.getGroupManager()
.getJoinedGroupList();
if (getJoinedGroupListRes.code == 0) {
// 查询成功
getJoinedGroupListRes.data?.forEach((element) => {
element.createTime; // 群创建时间
element.customInfo; // 群自定义字段
element.faceUrl; // 群头像Url
element.groupAddOpt; // 群添加选项设置
element.groupID; // 群ID
element.groupName; // 群名
element.groupType; // 群类型
element.introduction; // 群介绍
element.isAllMuted; // 群是否全体禁言
element.isSupportTopic; // 群是否支持话题
element.joinTime; // 当前用户在此群的加入时间
element.lastInfoTime; // 最后一次群修改资料的时间
element.lastMessageTime; // 最后一次群发消息的时间
element.memberCount; // 群员数量
element.notification; // 群公告
element.onlineCount; // 群在线人数
element.owner; // 群主
element.recvOpt; // 当前用户在此群中接受信息的选项
element.role; // 此用户在群中的角色
});
}