房间内成员自定义属性
功能介绍
房间内成员自定义属性用于在成员维度存储业务侧需要的键值信息,例如头像地址、身份或权限标记等。同一房间内的成员属性是共享的,可以互相获取。
本模块提供完整的生命周期能力:设置指定成员的整包属性、查询(支持批量成员)全部属性或指定键、增量添加或更新、按键删除、清空指定成员全部属性,以及清空当前房间内所有成员的全部属性;各操作通过异步接口发起,结果在对应回调中返回。属性发生变更时,还可通过通知接口获知更新(详见 notifyUserAttrsChanged)。
下文按典型操作分节说明接口调用与对应回调,各小节末尾列出相关 API 链接。
1.设置成员属性
- 调用接口:
NSArray<NSString*> *userIDs = @[@"111", @"222"];
MeetingAttrs *attrs = [NSMutableDictionary dictionary];
[attrs setValue:@"" forKey:@""];
[[RTCMeeting shareInstance] setUserAttrs:userIDs attrs:attrs options:nil cookie:@""];
- 回调通知:
-(void)setUserAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie {
// TODO Auto-generated method stub
}
相关API请参考:
2.获取当前指定成员属性
- 调用接口:
NSArray<NSString*> *userIDs = @[@"111", @"222"];
NSArray<NSString*> *keys = @[@""];
[[RTCMeeting shareInstance] getUserAttrs:userIDs keys:keys cookie:@""];
- 回调通知:
-(void)getUserAttrsSuccess:(UsrMeetingAttrs*)attrMap cookie:(NSString *)cookie {
// TODO Auto-generated method stub
}
-(void)getUserAttrsFail:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie {
// TODO Auto-generated method stub
}
相关API请参考:
10.添加或更新指定成员指定的属性
- 调用接口:
NSArray<NSString*> *userIDs = @[@"111", @"222"];
NSMutableDictionary *attrs = [NSMutableDictionary dictionary];
[attrs setValue:@"" forKey:@"MeetingName"];
[attrs setValue:@"" forKey:@"departmentName"];
[[RTCMeeting shareInstance] getUserAttrs:userIDs attrs:attrs options:nil cookie:@""];
- 回调通知:
-(void)addOrUpdateUserAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie {
// TODO Auto-generated method stub
}
相关API请参考:
3.删除指定成员的指定属性
- 调用接口:
NSArray<NSString*> *userID = @"111";
NSArray<NSString*> *keys = @[@"name", @"companyName"];
NSMutableDictionary *options = [NSMutableDictionary dictionary];
[[RTCMeeting shareInstance] delUserAttrs:userID keys:keys options:options cookie:@""];
- 回调通知:
-(void)delUserAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie {
// TODO Auto-generated method stub
}
相关API请参考:
4.清除当前指定成员全部属性
- 调用接口:
NSString *userID = @"111";
NSMutableDictionary *options = [NSMutableDictionary dictionary];
[[RTCMeeting shareInstance] clearUserAttrs:userID options:options cookie:@""];
- 回调通知:
-(void)clearUserAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie {
// TODO Auto-generated method stub
}
相关API请参考:
5.清除当前房间内所有成员全部属性
- 调用接口:
NSMutableDictionary *options = [NSMutableDictionary dictionary];
[[RTCMeeting shareInstance] clearAllUserAttrs:options cookie:@""];
- 回调通知:
-(void)clearAllUserAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie {
// TODO Auto-generated method stub
}
相关API请参考: