getSpecifiedGroupsInfo
功能介绍
说明
获取指定群信息。
注意
群列表建议一次最大 100 个。
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<List<GroupInfo>> getGroupsInfo({
required List<String> groupIDList,
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupIDList | List<String> | 是 | 群ID 列表 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
~ | List<GroupInfo> | 成功返回 |
代码示例
List<GroupInfo> list = await OpenIM.iMManager.groupManager.getGroupsInfo(
groupIDList: [],
);
// todo
函数原型
- (void)getSpecifiedGroupsInfo:(NSArray <NSString *> *)groupsID
onSuccess:(nullable OIMGroupsInfoCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupsID | NSArray <NSString *> | 是 | 群ID 列表 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
onSuccess | NSArray< OIMGroupInfo *> | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager getSpecifiedGroupsInfo:@[]
onSuccess:^(NSArray<OIMGroupInfo *> * _Nullable groupsInfo) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
函数原型
public void getGroupsInfo(OnBase<List<GroupInfo>> base, List<String> gidList)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callBack | OnBase<List<GroupInfo>> | 是 | 回调接口 |
gidList | List<String> | 是 | 群ID 列表 |
返回结果
代码示例
OpenIMClient.getInstance().groupManager.getGroupsInfo(new OnBase<List<GroupInfo>>() {
@Override
public void onError(int code, String error) {
}
@Override
public void onSuccess(List<GroupInfo> data) {
}
},gidList);
函数原型
IMSDK.getSpecifiedGroupsInfo(groupIDList: string[], operationID?: string): Promise<WsResponse<GroupInfo[]>>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupIDList | string[] | 是 | 群组 ID 列表 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse<GroupInfo[]>> | 群组信息列表 |
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();
const groupIDList = ['userID1', 'userID2'];
IMSDK.getSpecifiedGroupsInfo(groupIDList)
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('getSpecifiedGroupsInfo', operationID: string, groupIDList: string[]): Promise<GroupInfo[]>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
groupIDList | string[] | 是 | 群组 ID 列表 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<GroupInfo[]> | 群组信息列表 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
const groupIDList = ['userID1', 'userID2'];
IMSDK.asyncApi('getSpecifiedGroupsInfo', IMSDK.uuid(), groupIDList)
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.getSpecifiedGroupsInfo(groupIDList: string[], operationID: string): Promise<GroupInfo[]>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
groupIDList | string[] | 是 | 群组 ID 列表 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<GroupInfo[]> | 群组信息列表 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
const groupIDList = ['userID1', 'userID2'];
OpenIMSDKRN.getSpecifiedGroupsInfo(groupIDList, 'operationID')
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});