joinGroup

功能介绍

说明

申请加入群组。

注意

根据进群验证选项 确定申请进群结果。

相关回调:
onJoinedGroupAdded
onGroupMemberAdded
onGroupApplicationAdded

iOS

函数原型

Future<dynamic> joinGroup({
    required String groupID,
    String? reason,
    String? operationID,
    int joinSource = 3,
  })

输入参数

参数名称	参数类型	是否必填	描述
groupID	String	是	群ID
reason	Sting	否	请求信息
joinSource	int	是	请求来源 2：通过邀请 3：通过搜索 4：通过二维码

返回结果

参数名称	参数类型	描述
~	~	无异常抛出则申请成功

代码示例

    await OpenIM.iMManager.groupManager.joinGroup(
      groupID: '',
      reason: '',
      joinSource: 2,
     );
    // todo

Android

函数原型

- (void)joinGroup:(NSString *)groupID
           reqMsg:(NSString *)reqMsg
       joinSource:(OIMJoinType)joinSource
        onSuccess:(OIMSuccessCallback)onSuccess
        onFailure:(OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
groupID	NSString	是	群ID
reqMsg	NSSting	否	请求信息
joinSource	OIMJoinType	是	加入途径

返回结果

参数名称	参数类型	描述
onSuccess	OIMSuccessCallback	成功返回
onFailure	OIMFailureCallback	失败返回

代码示例

[OIMManager.manager joinGroup:@""
                       reqMsg:nil
                    onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Flutter

函数原型

    public void joinGroup(OnBase<String> callBack, String gid, String reason, int joinSource)

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase	是	回调接口
gid	String	是	群ID
reason	Sting	否	请求信息
joinSource	int	是	JoinSource 请求来源

返回结果

代码示例

OpenIMClient.getInstance().groupManager.joinGroup(new OnBase<String>() {
            @Override
            public void onError(int code, String error) {

            }

            @Override
            public void onSuccess(String data) {

            }
        }, gid,  reason,  joinSource);

uni-app

函数原型

IMSDK.joinGroup({
  groupID: string;
  reqMsg: string;
  joinSource: GroupJoinSource;
}, operationID?: string): Promise<WsResponse>

输入参数

参数名称	参数类型	是否必填	描述
groupID	string	是	群ID
reqMsg	string	是	入群申请信息
joinSource	GroupJoinSource	是	加入途径

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse>	调用成功回调
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

import { getSDK } from '@openim/wasm-client-sdk';
import { GroupJoinSource } from '@openim/wasm-client-sdk/lib/types/enum';
const IMSDK = getSDK();

IMSDK.joinGroup({
  groupID: '',
  reqMsg: '',
  joinSource: GroupJoinSource.Search,
})
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('joinGroup', operationID: string, {
  groupID: string;
  reqMsg: string;
  joinSource: GroupJoinSource;
}): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
groupID	string	是	群ID
reqMsg	string	是	入群申请信息
joinSource	GroupJoinSource	是	加入途径

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK, { GroupJoinSource } from 'openim-uniapp-polyfill';

IMSDK.asyncApi('joinGroup', IMSDK.uuid(), {
  groupID: '',
  reqMsg: '',
  joinSource: GroupJoinSource.Search,
})
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.joinGroup({
  groupID: string,
  reqMsg: string,
  joinSource: GroupJoinSource.Search,
}, operationID: string): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
groupID	string	是	群ID
reqMsg	string	是	入群申请信息
joinSource	GroupJoinSource	是	加入途径
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import OpenIMSDKRN from "open-im-sdk-rn";

OpenIMSDKRN.joinGroup({
  groupID: '',
  reqMsg: '',
  joinSource: GroupJoinSource.Search,
}, 'operationID')
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void JoinGroup(OnBase<bool> cb, string groupId, string reqMsg, JoinSource joinSource, string ex)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnBase	是	回调
groupId	string	是	群ID
reqMsg	string	否	请求信息
joinSource	JoinSource	是	请求来源
ex	string	是	扩展字段

返回结果

代码示例

IMSDK.JoinGroup((suc,errCode,errMsg)=>{

},groupId,reqMsg,joinSource,ex);