tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

React Native

PDF
聚焦模式
字号
最后更新时间: 2024-11-20 15:57:54

功能描述

基于群属性,我们可以做语聊房的麦位管理。当有人上麦的时候,可以设置一个群属性管理上麦人信息。当有人下麦的时候,可以删除对应群属性。其他成员可以通过获取群属性列表来展示麦位列表。
说明:
话题不支持群属性。
群属性功能特性有:
1. 群属性 key 最多支持 16 个,大小限制为 32 字节;value 大小限制为 4k;总的 groupAttributes(包括 key 和 value)大小限制为 16k,
当每次登录成功后初次修改群属性时,请您先调用 getGroupAttributes 拉取到最新的群属性之后,再发起修改操作。
2. 当多个用户同时修改同一个群属性时,只有第一个用户可以执行成功,其它用户会收到 10056 错误码;收到这个错误码之后,请您调用 getGroupAttributes 把本地保存的群属性更新到最新之后,再发起修改操作。
3. 登录成功后直播群(AVChatRoom)使用该功能必须先调用 joinGroup 加入直播群,Public、Meeting、Work、Community 类型群组如果已加群,则不需要重复进行加群操作。

初始化群属性

接口
chat.initGroupAttributes(options);
参数
参数 optionsObject类型,包含的属性值如下:
参数
类型
说明
groupID
String
群组 ID
groupAttributes
Object
群属性
返回值
Promise
示例
let promise = chat.initGroupAttributes({
groupID: 'group1',
groupAttributes: { key1: 'value1', key2: 'value2' }
});
promise.then(function(imResponse) { // 初始化成功
console.log(imResponse.data.groupAttributes); // 初始化成功的群属性
}).catch(function(imError) { // 初始化失败
console.warn('initGroupAttributes error:', imError); // 初始化群属性失败的相关信息
});

设置群属性

接口
chat.setGroupAttributes(options);
参数
参数 optionsObject类型,包含的属性值如下:
参数
类型
说明
groupID
String
群组 ID
groupAttributes
Object
群属性
返回值
Promise
示例
let promise = chat.setGroupAttributes({
groupID: 'group1',
groupAttributes: { key1: 'value1', key2: 'value2' }
});
promise.then(function(imResponse) { // 设置成功
console.log(imResponse.data.groupAttributes); // 设置成功的群属性
}).catch(function(imError) { // 设置失败
console.warn('setGroupAttributes error:', imError); // 设置群属性失败的相关信息
});

删除群属性

说明:
1. keyList 传入非空数组表示删除指定的群属性 key-value,传入空数组表示删除全部群属性。
接口
chat.deleteGroupAttributes(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
参数
类型
说明
groupID
String
群组 ID
keyList
Array
群属性 key 列表
返回值
Promise
示例
// 删除指定的群属性 key-value
let promise = chat.deleteGroupAttributes({
groupID: 'group1',
keyList: ['key1', 'key2']
});
promise.then(function(imResponse) { // 删除成功
console.log(imResponse.data.keyList); // 删除成功的群属性 key 列表
}).catch(function(imError) { // 删除失败
console.warn('deleteGroupAttributes error:', imError); // 删除群属性失败的相关信息
});
// 删除全部群属性
let promise = chat.deleteGroupAttributes({
groupID: 'group1',
keyList: []
});
promise.then(function(imResponse) { // 删除成功
console.log(imResponse.data.keyList); // 删除成功的群属性 key 列表
}).catch(function(imError) { // 删除失败
console.warn('deleteGroupAttributes error:', imError); // 删除群属性失败的相关信息
});

获取群属性

说明:
keyList 传入非空数组表示获取指定的群属性,传入空数组表示获取全部群属性。
接口
chat.getGroupAttributes(options);
参数
参数 optionsObject类型,包含的属性值如下:
参数
类型
说明
groupID
String
群组 ID
keyList
Array
群属性 key 列表
返回值
Promise
示例
// 获取指定的群属性
let promise = chat.getGroupAttributes({
groupID: 'group1',
keyList: ['key1', 'key2']
});
promise.then(function(imResponse) { // 获取成功
console.log(imResponse.data.groupAttributes); // 指定 key 的群属性
}).catch(function(imError) { // 获取失败
console.warn('getGroupAttributes error:', imError); // 获取群属性失败的相关信息
});
// 获取全部群属性
let promise = chat.getGroupAttributes({
groupID: 'group1',
keyList: []
});
promise.then(function(imResponse) { // 获取成功
console.log(imResponse.data.groupAttributes); // 全部群属性
}).catch(function(imError) { // 获取失败
console.warn('getGroupAttributes error:', imError); // 获取群属性失败的相关信息
});

监听群属性更新事件

示例
let onGroupAttributesUpdated = function(event) {
const groupID = event.data.groupID // 群组ID
const groupAttributes = event.data.groupAttributes // 更新后的群属性
console.log(event.data);
};
chat.on(TencentCloudChat.EVENT.GROUP_ATTRIBUTES_UPDATED, onGroupAttributesUpdated);


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈