inviteUserToGroup

功能介绍

说明

邀请用户进群。

注意

根据调用者身份以及进群验证选项 确定邀请进群结果。

相关回调:
onJoinedGroupAdded
onGroupMemberAdded
onGroupApplicationAdded

iOS

函数原型

  Future<List<GroupInviteResult>> inviteUserToGroup({
    required String groupID,
    required List<String> userIDList,
    String? reason,
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
groupID	String	是	群ID
reason	String	是	邀请信息
userIDList	List<String>	是	被邀请用户 userID 列表

返回结果

参数名称	参数类型	描述
~	List<GroupInviteResult>	成功返回

GroupInviteResult

字段名称	字段类型	描述
userID	String	用户ID
result	Int	邀请结果

代码示例

    List<GroupInviteResult> list =  await OpenIM.iMManager.groupManager.inviteUserToGroup(
        groupID: '',
        userIDList: [],
      );
     // todo

Android

函数原型

- (void)inviteUserToGroup:(NSString *)groupID
                   reason:(NSString *)reason
                  usersID:(NSArray <NSString *> *)usersID
                onSuccess:(nullable OIMSimpleResultsCallback)onSuccess
                onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
groupID	NSString	是	群ID
reason	NSSting	是	邀请信息
usersID	NSArray <NSString *>	是	被邀请用户 userID 列表

返回结果

参数名称	参数类型	描述
onSuccess	NSArray<OIMSimpleResultInfo * >	成功返回
onFailure	OIMFailureCallback	失败返回

OIMSimpleResultInfo

字段名称	字段类型	描述
userID	NSString	用户ID
result	NSInteger	邀请结果

代码示例

[OIMManager.manager inviteUserToGroup:@""
                               reason:@""
                              usersID:@[]
                          onSuccess:^(NSArray<OIMSimpleResultInfo *> * _Nullable results) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Flutter

函数原型

public void inviteUserToGroup(OnBase<List<GroupInviteResult>> callBack, String groupId, List<String> uidList, String reason)

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase<List<ResultInfo>>	是	回调接口
groupId	String	是	群ID
reason	Sting	是	邀请信息
uidList	List<String>	是	被邀请人 ID 集合

返回结果

代码示例

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

            }

            @Override
            public void onSuccess(List<GroupInviteResult> data) {

            }
        },groupId,uidList,reason)

uni-app

函数原型

IMSDK.inviteUserToGroup({
  groupID: string;
  reason: string;
  userIDList: string[];
}, operationID?: string): Promise<WsResponse>

输入参数

参数名称	参数类型	是否必填	描述
groupID	string	是	群ID
reason	string	是	邀请信息
userIDList	string[]	是	被邀请用户 userID 列表

返回结果

参数名称	参数类型	描述
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 { getSDK } from '@openim/client-sdk';
// const IMSDK = getSDK();

IMSDK.inviteUserToGroup({
  groupID: '',
  reason: '',
  userIDList: ['userID'],
})
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('inviteUserToGroup', operationID: string, {
  groupID: string;
  reason: string;
  userIDList: string[];
}): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
groupID	string	是	群ID
reason	string	是	邀请信息
userIDList	string[]	是	被邀请用户 userID 列表

返回结果

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

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

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('inviteUserToGroup', IMSDK.uuid(), {
  groupID: '',
  reason: '',
  userIDList: ['userID'],
})
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDK.inviteUserToGroup({
  groupID: string,
  reason: string,
  userIDList: string[], 
}, operationID?: string): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
groupID	string	是	群ID
reason	string	是	邀请信息
userIDList	string[]	是	被邀请用户 userID 列表
operationID	string	否	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

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

代码示例

import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDK.inviteUserToGroup({
  groupID: '',
  reason: '',
  userIDList: ['userID'],
})
  .then(() => {
    // 调用成功
  })
  .catch((error) => {
    // 调用失败
  });

Unity

函数原型

public static void InviteUserToGroup(OnBase<bool> cb, string groupId, string reason, string[] userIdList)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnBase	是	回调接口
groupId	string	是	群ID
reason	sting	是	邀请信息
userIdList	string[]	是	被邀请人 ID 集合

返回结果

代码示例

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

},groupId,uidList,reason);