getUsersInGroup

功能介绍

说明

查找一批用户是否在指定群组内。

iOS

函数原型

Future<dynamic> getUsersInGroup(
    String groupID,
    List<String> userIDs, {
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
groupID	String	是	群ID
userIDs	List< String>	是	用户ID 列表

返回结果

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

代码示例

   await OpenIM.iMManager.groupManager.getUsersInGroup(
      groupID: '',
      userIDs: []
    );
    // todo

Android

函数原型

- (void)getUsersInGroup:(NSString *)groupID
                userIDs:(NSArray<NSString *> *)userIDs
            onSuccess:(nullable OIMStringArrayCallback)onSuccess
            onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
groupID	NSString	是	群ID
userIDs	NSArray< String>	是	用户ID 列表

返回结果

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

代码示例

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

Flutter

函数原型

 public void getUsersInGroup(OnBase<String[]> callBack, String groupId, String[] userIdList)

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase	是	回调接口
groupID	string	是	群ID
userIDList	string[]	是	用户ID 列表

返回结果

代码示例

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

            }

            @Override
            public void onSuccess(String[] data) {

            }
        },gid);

uni-app

函数原型

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

输入参数

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

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse<string[]>>	调用成功回调
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.getUsersInGroup({
  groupID: 'groupID',
  userIDList: ['userIDList'],
})
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

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

输入参数

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

返回结果

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

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

代码示例

import IMSDK from 'openim-uniapp-polyfill';

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

React-Native

函数原型

OpenIMSDK.getUsersInGroup({
  groupID: string;
  userIDList: string[];
}, operationID?: string): Promise<string[]>

输入参数

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

返回结果

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

代码示例

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

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

Unity

函数原型

public static void GetUsersInGroup(OnBase<string[]> cb, string groupId, string[] userIdList)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnBase	是	回调函数
groupId	string	是	群ID
userIdList	string[]	是	用户ID 列表

返回结果

代码示例

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

},groupId,{"userId"});