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