addFriend
功能介绍
说明
发起好友申请,请求添加对方为好友。
注意
相关回调:
onFriendApplicationAdded
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<dynamic> addFriend({
required String userID,
String? reason,
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
userID | String | 是 | 要添加的用户 ID |
reason | String | 是 | 请求信息 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
~ | ~ | 无异常抛出则添加成功 |
代码示例
await OpenIM.iMManager.friendshipManager.addFriend(userID: 'userID',reason: 'i want to');
// todo
函数原型
- (void)addFriend:(NSString *)userID
reqMessage:(NSString * _Nullable)reqMessage
onSuccess:(nullable OIMSuccessCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
userID | NSString | 是 | 要添加的用户 ID |
reqMessage | NSString | 是 | 请求信息 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
onSuccess | OIMSuccessCallback | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager addFriend:@""
reqMessage:@""
onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
函数原型
public void addFriend(OnBase<String> callBack, String uid,String reqMessage)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callBack | OnBase | 是 | 回调接口 |
uid | String | 是 | 用户 ID |
reqMessage | String | 是 | 请求添加好友时对方看到的消息 |
返回结果
代码示例
OpenIMClient.getInstance().friendshipManager.addFriend(new OnBase<String>(){...},uid,reqMessage)
函数原型
IMSDK.addFriend({
toUserID: string;
reqMsg: string;
}, operationID?: string): Promise<WsResponse>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
toUserID | string | 是 | 要添加的用户 ID |
reqMsg | string | 是 | 好友请求信息 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse> | 调用成功回调 |
Promise.catch() | Promise<WsResponse> | 调用失败回调 |
代码示例
import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();
// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();
// use in mini program
// import { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.addFriend({
toUserID: '',
reqMsg: '',
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('addFriend', operationID: string, {
toUserID: string;
reqMsg: string;
}): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
toUserID | string | 是 | 要添加的用户 ID |
reqMsg | string | 是 | 好友请求信息 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('addFriend', IMSDK.uuid(), {
toUserID: '',
reqMsg: '',
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.addFriend({
toUserID: string;
reqMsg: string;
}, operationID?: string): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
toUserID | string | 是 | 要添加的用户 ID |
reqMsg | string | 是 | 好友请求信息 |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.addFriend({
toUserID: '',
reqMsg: '',
}, 'operationID');
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});