用户管理
功能简介
ZIM SDK 提供了用户管理功能,支持用户上传自己的个人信息,更新自己的用户名称、头像,以及查询自己的个人信息等。
实现流程
用户扩展字段管理
ZIM SDK 提供了用户信息的扩展字段,用于描述用户的其他相关属性。开发者可以使用扩展字段,通过 updateUserExtendedData 接口,自定义用户的扩展字段。扩展字段可由开发者自行定义其使用方式,SDK 只会将该字段透传,不会做其它处理。
修改扩展字段属性后,用户可以通过 ZIMUserExtendedDataUpdatedCallback 收到修改结果。
// 更新用户信息的扩展字段。
NSString *extendedData = @"";
[zim updateUserExtendedData:extendedData callback:^(NSString * _Nonnull extendedData, ZIMError * _Nonnull errorInfo) {
}];
修改用户名称
用户名称 userName
,是指用来描述用户昵称的字符串,开发者可以通过 ZIMUserInfo 对象进行配置。ZIM SDK 支持用户在登录后,通过 updateUserName 接口修改自己的用户名称。
修改用户名称后,用户可以通过 ZIMUserNameUpdatedCallback 收到修改结果。
// 修改用户名。
// `userName` 参数的长度可以达到256字节,字符数没有限制。
NSString *userName = @"";
[zim updateUserName:userName callback:^(NSString * _Nonnull userName, ZIMError * _Nonnull errorInfo) {
}];
设置用户头像
ZIM SDK 支持用户在登录后,通过 updateUserAvatarUrl 接口设置或修改自己的用户头像。
设置用户头像后,用户可以通过 ZIMUserAvatarUrlUpdatedCallback 收到设置结果。
当一名用户修改头像后,其他用户需调用 queryUsersInfo 接口,并将 ZIMUsersInfoQueryConfig 中 isQueryFromServer 参数赋值为 true
重新 查询用户信息,才会获取最新头像。
// 设置用户头像。
// URL的长度可以达到500字节,字符数没有限制。
NSString *userAvatarUrl = @"";
[zim updateUserAvatarUrl callback:^(NSString * _Nonnull userAvatarUrl, ZIMError * _Nonnull errorInfo) {
}];
查询用户信息
用户可以通过 queryUsersInfo 接口,查询指定用户的全量信息,包括用户名称、用户扩展字段。用户头像 URL、用户扩展字段信息,仅在该接口中可以获取到。
查询信息后,用户可以通过 ZIMUsersInfoQueriedCallback 收到查询结果。
// 查询用户信息。
// 限制:每次调用最多可以查询10个用户ID,或者在10秒内多次调用。
[self.zim queryUsersInfo:@[@"userID_1",@"userID_2"] callback:^(NSArray<ZIMUserFullInfo *> * _Nonnull userList, NSArray<ZIMErrorUserInfo *> * _Nonnull errorUserList, ZIMError * _Nonnull errorInfo) {
}];