房间内成员自定义属性
功能介绍
房间内成员自定义属性用于在成员维度存储业务侧需要的键值信息,例如头像地址、身份或权限标记等。同一房间内的成员属性是共享的,可以互相获取。
本模块提供完整的生命周期能力:设置指定成员的整包属性、查询(支持批量成员)全部属性或指定键、增量添加或更新、按键删除、清空指定成员全部属性,以及清空当前房间内所有成员的全部属性;各操作通过异步接口发起,结果在对应回调中返回。属性发生变更时,还可通过 notifyUserAttrsChanged 获知更新。
1. 设置成员属性
- 调用接口:
String userID = "111";
HashMap<String, String> attrs = new HashMap<String, String>() {{
put("key1", "value1");
put("key2", "value2");
}};
RTCMeeting.getInstance().setUserAttrs(userID, attrs, "");
- 回调通知:
@Override
void setUserAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie) {
}
相关 API 请参考:
2. 获取当前指定成员所有属性
- 调用接口:
List<String> userIDs = Arrays.asList("111", "222");
RTCMeeting.getInstance().getUserAttrs(userIDs, "");
- 回调通知:
@Override
void getUserAttrsSuccess(HashMap<String, HashMap<String, MeetingAttr>> attrMap, String cookie) {
}
@Override
void getUserAttrsFail(CRVIDEOSDK_ERR_DEF err, String cookie) {
}
相关 API 请参考:
3. 获取当前指定成员指定属性
- 调用接口:
List<String> userIDs = Arrays.asList("111", "222");
List<String> keys = Arrays.asList("name", "companyName");
RTCMeeting.getInstance().getUserAttrs(userIDs, keys, "");
相关 API 请参考:
4. 添加或更新指定成员指定的属性
- 调用接口:
String userID = "111";
HashMap<String, String> attrs = new HashMap<String, String>() {{
put("key1", "value1");
put("key2", "value2");
}};
RTCMeeting.getInstance().addOrUpdateUserAttrs(userID, attrs, "");
- 回调通知:
@Override
void addOrUpdateUserAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie) {
}
相关 API 请参考:
5. 删除指定成员的指定属性
- 调用接口:
String userID = "111";
List<String> keys = Arrays.asList("department", "companyName");
RTCMeeting.getInstance().delUserAttrs(userID, keys, "");
- 回调通知:
@Override
void delUserAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie) {
}
相关 API 请参考:
6. 清除当前指定成员全部属性
- 调用接口:
String userID = "111";
RTCMeeting.getInstance().clearUserAttrs(userID);
- 回调通知:
@Override
void clearUserAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie) {
}
相关 API 请参考:
7. 清除当前房间内所有成员全部属性
- 调用接口:
RTCMeeting.getInstance().clearAllUserAttrs("");
- 回调通知:
@Override
void clearAllUserAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie) {
}
相关 API 请参考: