用户资料

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

平台调用风格

进程模型:main(IMLib 客户端 + 本地 SQLite,单写者)/ preload(contextBridge 白名单)/ renderer(薄代理,不直连网络与数据库)。异步接口返回 Promise<RcResult<T>>。

接口一览​

操作语义传输返回
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(userId: string): Promise<RcResult<UserProfile>>
REST(客户端)since 1.0.0
参数
参数类型说明
userIdstring必填;用户 ID
返回

UserProfile 用户资料

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

updateMyUserProfile​

修改本人资料(name/avatarUrl)。

updateMyUserProfile(profile: {name?: string; avatarUrl?: string}): Promise<RcResult<UserProfile>>
REST(客户端)since 1.0.0
参数
参数类型说明
profile{name?:string, avatarUrl?:string}必填;待更新的资料字段:{ name?:string, avatarUrl?:string }
返回

UserProfile 用户资料

示例
JavaScript
const res = await client.updateMyUserProfile({  });
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

相关文档​