房间内成员自定义属性
功能介绍
房间内成员自定义属性用于在成员维度存储业务侧需要的键值信息,例如头像地址、身份或权限标记等。同一房间内的成员属性是共享的,可以互相获取。
本模块提供完整的生命周期能力:设置指定成员的整包属性、查询(支持批量成员)全部属性或指定键、增量添加或更新、按键删除、清空指定成员全部属性,以及清空当前房间内所有成员的全部属性;各操作通过异步接口发起,结果在对应回调中返回。
1. 设置成员属性
- 调用接口:
const rtcsdk = new RTCSDK();
const userID = "111";
const attrs = '{"name":"Bob", "companyName":"ABC"}';
rtcsdk.setUserAttrs(userID, attrs, "", "");
- 回调通知:
rtcsdk.on('setUserAttrsRslt', (data) => {
if (data.sdkErr === 0) {
// 成功
}
});
相关 API 请参考:
2. 获取指定成员全部属性
- 调用接口:
const rtcsdk = new RTCSDK();
const userIDs = '["111", "222"]';
rtcsdk.getUserAttrs(userIDs, "", "");
- 回调通知:
rtcsdk.on('getUserAttrsSuccess', (data) => {
const { attrsMap } = data;
// 获取用户属性成功后的结果
});
rtcsdk.on('getUserAttrsFail', (data) => {
const { sdkErr } = data;
// 获取用户属性失败
});
相关 API 请参考:
3. 获取指定成员指定属性
- 调用接口:
const rtcsdk = new RTCSDK();
const userIDs = '["111", "222"]';
const keys = '["name", "companyName"]';
rtcsdk.getUserAttrs(userIDs, keys, "");
相关 API 请参考:
4. 添加或更新指定成员指定的属性
- 调用接口:
const rtcsdk = new RTCSDK();
rtcsdk.addOrUpdateUserAttrs("111", '{"department":"R&D"}', "", "");
- 回调通知:
rtcsdk.on('addOrUpdateUserAttrsRslt', (data) => {
if (data.sdkErr === 0) {
// 成功
}
});
相关 API 请参考:
5. 删除指定成员的指定属性
- 调用接口:
const rtcsdk = new RTCSDK();
const keys = '["department", "companyName"]';
rtcsdk.delUserAttrs("111", keys, "", "");
- 回调通知:
rtcsdk.on('delUserAttrsRslt', (data) => {
if (data.sdkErr === 0) {
// 成功
}
});
相关 API 请参考:
6. 清除指定成员全部属性
- 调用接口:
const rtcsdk = new RTCSDK();
rtcsdk.clearUserAttrs("111", "", "");
- 回调通知:
rtcsdk.on('clearUserAttrsRslt', (data) => {
if (data.sdkErr === 0) {
// 成功
}
});
相关 API 请参考:
7. 清除当前房间内所有成员全部属性
- 调用接口:
const rtcsdk = new RTCSDK();
rtcsdk.clearAllUserAttrs("", "");
- 回调通知:
rtcsdk.on('clearAllUserAttrsRslt', (data) => {
if (data.sdkErr === 0) {
// 成功
}
});
相关 API 请参考: