成员自定义属性
功能介绍
成员自定义属性用于在成员维度存储业务侧需要的键值信息,例如身份、权限标记、业务扩展字段等。同一房间内的成员属性是共享的,可以互相获取。
本模块提供完整的生命周期能力:设置指定成员的整包属性、查询(支持批量成员)全部属性或指定键、增量添加或更新、按键删除、清空指定成员全部属性,以及清空当前房间内所有成员的全部属性;各操作通过异步接口发起,结果在对应回调中返回。属性发生变更时,可通过 CRVideo_NotifyUserAttrsChanged 获知更新。
房间维度的自定义属性见 房间自定义属性。
注意:
须在成功进入房间后,方可设置或查询成员自定义属性。
下文按典型操作分节说明接口调用与对应回调,各小节末尾列出相关 API 链接。
1. 设置成员属性
- 调用接口:
var UID = "111";
var attrs = {"name": "Bob", "companyName": "ABC"};
var options = {"notifyAll": 1};
CRVideo_SetUserAttrs(UID, attrs, options, cookie);
- 回调通知:
CRVideo_SetUserAttrsRslt.callback = function(sdkErr, cookie){
if (sdkErr != 0){
// 失败
} else {
// 成功
}
}
相关 API 请参考:
2. 获取指定成员全部属性
- 调用接口:
var UIDs = ["111", "222"]; // 一次最多 50 个用户
CRVideo_GetUserAttrs(UIDs, [], cookie); // keys 传空数组表示获取全部属性
- 回调通知:
CRVideo_GetUserAttrsSuccess.callback = function(attrsMap, cookie){
// 获取成功,attrsMap 为各用户属性集合
}
CRVideo_GetUserAttrsFail.callback = function(sdkErr, cookie){
// 获取失败
}
相关 API 请参考:
3. 获取指定成员指定属性
- 调用接口:
var UIDs = ["111", "222"];
var keys = ["name", "companyName"];
CRVideo_GetUserAttrs(UIDs, keys, cookie);
- 回调通知:
CRVideo_GetUserAttrsSuccess.callback = function(attrsMap, cookie){
// 获取成功
}
CRVideo_GetUserAttrsFail.callback = function(sdkErr, cookie){
// 获取失败
}
相关 API 请参考:
4. 添加或更新指定成员属性
- 调用接口:
var UID = "111";
var attrs = {"department": "R&D", "companyName": "ABC"};
var options = {"notifyAll": 1};
CRVideo_AddOrUpdateUserAttrs(UID, attrs, options, cookie);
- 回调通知:
CRVideo_AddOrUpdateUserAttrsRslt.callback = function(sdkErr, cookie){
if (sdkErr != 0){
// 失败
} else {
// 成功
}
}
相关 API 请参考:
5. 删除指定成员的指定属性
- 调用接口:
var UID = "111";
var keys = ["department", "companyName"];
var options = {"notifyAll": 1};
CRVideo_DelUserAttrs(UID, keys, options, cookie);
- 回调通知:
CRVideo_DelUserAttrsRslt.callback = function(sdkErr, cookie){
if (sdkErr != 0){
// 失败
} else {
// 成功
}
}
相关 API 请参考:
6. 清除指定成员全部属性
- 调用接口:
var UID = "111"; // 也可传 UID 数组
var options = {"notifyAll": 1};
CRVideo_ClearUserAttrs(UID, options, cookie);
- 回调通知:
CRVideo_ClearUserAttrsRslt.callback = function(sdkErr, cookie){
if (sdkErr != 0){
// 失败
} else {
// 成功
}
}
相关 API 请参考:
7. 清除当前房间内所有成员全部属性
- 调用接口:
var options = {"notifyAll": 1};
CRVideo_ClearAllUserAttrs(options, cookie);
- 回调通知:
CRVideo_ClearAllUserAttrsRslt.callback = function(sdkErr, cookie){
if (sdkErr != 0){
// 失败
} else {
// 成功
}
}
相关 API 请参考: