好友列表

好友关系由服务端托管，支持搜索用户、备注、删除好友。

平台调用风格

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

接口一览​

操作语义传输返回
getFriends好友列表（含备注/在线/拉黑标记）。REST（客户端）[{userId:string,name?:string,avatarUrl?:string,remark?:string,online?:bool,blacklisted?:bool}]
searchUsers搜索用户（userId/name，大小写不敏感，排除自己）。REST（客户端）{users:[{userId:string,name:string,isFriend:bool,blacklisted:bool}], total:uint32}
setFriendRemark设置好友备注（<=64 字，空串清除）。REST（客户端）null
deleteFriend双向删除好友。REST（客户端）null

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

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
getFriendsgetFriendsgetFriendsgetFriendsgetFriendsgetFriends—func
searchUserssearchUserssearchUserssearchUserssearchUserssearchUsers—func
setFriendRemarksetFriendRemarksetFriendRemarksetFriendRemarksetFriendRemarksetFriendRemark—func
deleteFrienddeleteFrienddeleteFrienddeleteFrienddeleteFrienddeleteFriend—func

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

getFriends​

好友列表（含备注/在线/拉黑标记）。

getFriends(): Promise<RcResult<Array<{userId: string; name?: string; avatarUrl?: string; remark?: string; online?: boolean; blacklisted?: boolean}>>>
REST（客户端）since 1.0.0
返回

[{userId:string,name?:string,avatarUrl?:string,remark?:string,online?:bool,blacklisted?:bool}] 成功返回的数据；失败时按错误码处理

示例
JavaScript
const res = await client.getFriends();
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;

该操作未声明专属错误码；失败时按 SDK 通用错误处理，见 状态码。

searchUsers​

搜索用户（userId/name，大小写不敏感，排除自己）。

searchUsers(keyword: string, options?: {limit?: number}): Promise<RcResult<{users: Array<{userId: string; name: string; isFriend: boolean; blacklisted: boolean}>; total: number}>>
REST（客户端）since 1.0.0
参数
参数类型说明
keywordstring必填；搜索关键词（大小写不敏感）
options{limit?:uint32}可选；选项对象（字段见类型列）：{ limit?:uint32 }
返回

{users:[{userId:string,name:string,isFriend:bool,blacklisted:bool}], total:uint32} 成功返回的数据；失败时按错误码处理

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

setFriendRemark​

设置好友备注（<=64 字，空串清除）。

setFriendRemark(friendId: string, remark: string): Promise<RcResult<null>>
REST（客户端）since 1.0.0
参数
参数类型说明
friendIdstring必填；好友用户 ID
remarkstring必填；好友备注（<=64 字，空串清除）
返回

null 无返回数据；成功与否通过错误码判断

示例
JavaScript
await client.setFriendRemark('user2', '产品-小明'); /* code === 0 为成功 */
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

deleteFriend​

双向删除好友。

deleteFriend(friendId: string): Promise<RcResult<null>>
REST（客户端）幂等since 1.0.0
参数
参数类型说明
friendIdstring必填；好友用户 ID
返回

null 无返回数据；成功与否通过错误码判断

示例
JavaScript
await client.deleteFriend('user2'); /* code === 0 为成功 */
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

相关文档​