用户资料

获取与更新用户资料；资料由应用自有用户体系维护，IM 服务不强制托管。

平台调用风格

异步风格：Future<RcResult<T>>；错误码在 res.code，不使用异常表达业务失败。

接口一览​

操作语义传输返回
getUserProfile查询用户资料。REST（客户端）UserProfile
updateMyUserProfile修改本人资料（name/avatarUrl）。REST（客户端）UserProfile

本页 2 个操作，其中 2 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
getUserProfilegetUserProfilegetUserProfilegetUserProfilegetUserProfilegetUserProfile—func
updateMyUserProfileupdateMyUserProfileupdateMyUserProfileupdateMyUserProfileupdateMyUserProfileupdateMyUserProfile—func

方法名在 GA 平台之间保持一致（规则 A）；Native C ABI 只覆盖部分操作，其余操作以 — 标注。

getUserProfile​

查询用户资料。

getUserProfile(String userId)
REST（客户端）since 1.0.0
参数
参数类型说明
userIdstring必填；用户 ID
返回

UserProfile 用户资料

示例
Dart
final res = await engine.getUserProfile('user2');
if (res.code != 0) throw Exception(res.msg);
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在

updateMyUserProfile​

修改本人资料（name/avatarUrl）。

updateMyUserProfile({String? name, String? avatarUrl})
REST（客户端）since 1.0.0
参数
参数类型说明
profile{name?:string, avatarUrl?:string}必填；待更新的资料字段：{ name?:string, avatarUrl?:string }
返回

UserProfile 用户资料

示例
Dart
final res = await engine.updateMyUserProfile();
if (res.code != 0) throw Exception(res.msg);
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

相关文档​