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