用户资料

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

平台调用风格

异步风格：Promise<RcResult<T>>（{ code, data?, msg? }）；业务错误通过 res.code !== 0 判断，不抛异常。

接口一览

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

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

操作	Android	Web	Electron	macOS	Flutter	Native (C ABI)	iOS
`getUserProfile`	`getUserProfile`	`getUserProfile`	`getUserProfile`	`getUserProfile`	`getUserProfile`	—	`func`
`updateMyUserProfile`	`updateMyUserProfile`	`updateMyUserProfile`	`updateMyUserProfile`	`updateMyUserProfile`	`updateMyUserProfile`	—	`func`

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

查询用户资料。

getUserProfile(userId)

REST（客户端）since 1.0.0

参数

参数	类型	说明
`userId`	`string`	必填；用户 ID

UserProfile 用户资料

示例

const res = await client.getUserProfile('user2');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;

错误码

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

updateMyUserProfile({name?, avatarUrl?})

REST（客户端）since 1.0.0

参数

参数	类型	说明
`profile`	`{name?:string, avatarUrl?:string}`	必填；待更新的资料字段：{ name?:string, avatarUrl?:string }

UserProfile 用户资料

示例

const res = await client.updateMyUserProfile({  });
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1003`	`FORBIDDEN`	客户端 / 参数 / 权限	403	否	无权限