好友请求

好友请求全流程:发起、查询、接受、拒绝;对方同意后双方好友列表实时更新。

契约预留

本平台为 reserved:以下签名来自已冻结绑定,示例为契约样例,不承诺可运行。

平台调用风格

异步风格:Promise<RcResult<T>>(不 reject;错误码在 RcResult.code);uint64/int64 映射为 number,超出安全整数时由实现改用 string。

接口一览​

操作语义传输返回
sendFriendRequest发起好友申请;已是好友/已有 pending → 1003;被拉黑 → 1011。REST(客户端)FriendRequest
getFriendRequests好友申请列表(incoming/outgoing,pending/all)。REST(客户端)FriendRequest[]
acceptFriendRequest同意申请,双向建立好友关系。REST(客户端)FriendRequest
rejectFriendRequest拒绝申请。REST(客户端)FriendRequest

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

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
sendFriendRequestsendFriendRequestsendFriendRequestsendFriendRequestsendFriendRequestsendFriendRequest—func
getFriendRequestsgetFriendRequestsgetFriendRequestsgetFriendRequestsgetFriendRequestsgetFriendRequests—func
acceptFriendRequestacceptFriendRequestacceptFriendRequestacceptFriendRequestacceptFriendRequestacceptFriendRequest—func
rejectFriendRequestrejectFriendRequestrejectFriendRequestrejectFriendRequestrejectFriendRequestrejectFriendRequest—func

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

sendFriendRequest​

发起好友申请;已是好友/已有 pending → 1003;被拉黑 → 1011。

sendFriendRequest(toUserId: string, message?: string): Promise<RcResult<FriendRequest>>
REST(客户端)since 1.0.0
参数
参数类型说明
toUserIdstring必填;接收方用户 ID
messagestring可选;字段含义见类型定义
返回

FriendRequest 好友申请实体

示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.sendFriendRequest('user2', '你好,NI PaaS');
if (res.code !== 0) { console.error(res.msg); }
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在
1011BLOCKED客户端 / 参数 / 权限403否已被对方拉黑或你已拉黑对方

getFriendRequests​

好友申请列表(incoming/outgoing,pending/all)。

getFriendRequests(options?: FriendRequestQuery): Promise<RcResult<FriendRequest[]>>
REST(客户端)since 1.0.0
参数
参数类型说明
options{type?:'incoming'|'outgoing', status?:'pending'|'all'}可选;选项对象(字段见类型列):{ type?:'incoming'|'outgoing', status?:'pending'|'all' }
返回

FriendRequest[] 好友申请列表

示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.getFriendRequests({  });
if (res.code !== 0) { console.error(res.msg); }
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

acceptFriendRequest​

同意申请,双向建立好友关系。

acceptFriendRequest(requestId: string): Promise<RcResult<FriendRequest>>
REST(客户端)since 1.0.0
参数
参数类型说明
requestIdstring必填;好友申请 ID
返回

FriendRequest 好友申请实体

示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.acceptFriendRequest('req_1001');
if (res.code !== 0) { console.error(res.msg); }
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

rejectFriendRequest​

拒绝申请。

rejectFriendRequest(requestId: string): Promise<RcResult<FriendRequest>>
REST(客户端)since 1.0.0
参数
参数类型说明
requestIdstring必填;好友申请 ID
返回

FriendRequest 好友申请实体

示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.rejectFriendRequest('req_1001');
if (res.code !== 0) { console.error(res.msg); }
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

相关文档​