getJoinedGroupListPage
功能介绍
说明
分页获取已加入的群列表。offset为获取偏移量, count为获取个数。
注意
count数不要过大, 否则请求时长会过长
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<List<GroupInfo>> getJoinedGroupListPage({String? operationID, int offset = 0, int count = 40});
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
offset | int | 是 | 分页拉取起始下标 |
count | int | 是 | 一页拉取的数量 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
~ | List< GroupInfo> | 成功返回 |
代码示例
List<GroupInfo> list = await OpenIM.iMManager.groupManager.getJoinedGroupListPage();
// todo
函数原型
- (void)getJoinedGroupListPageWithOffset:(NSInteger)offset
count:(NSInteger)count
onSuccess:(nullable OIMGroupsInfoCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
offset | int | 是 | 分页拉取起始下标 |
count | int | 是 | 一页拉取的数量 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
onSuccess | NSArray< OIMGroupInfo *> | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager getJoinedGroupListWithOffset:
count:
onSuccess:^(NSArray<OIMGroupInfo *> * _Nullable groupsInfo) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
函数原型
public void getJoinedGroupList(OnBase<List<GroupInfo>> callBack)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callBack | OnBase<List<GroupInfo>> | 是 | 回调接口 |
返回结果
代码示例
OpenIMClient.getInstance().groupManager.getJoinedGroupList(new OnBase<List<GroupInfo>>() {
@Override
public void onError(int code, String error) {
}
@Override
public void onSuccess(List<GroupInfo> data) {
}
});
函数原型
IMSDK.getJoinedGroupList({
offset: number;
count: number;
}, operationID?: string): Promise<WsResponse<GroupItem[]>>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
offset | number | 是 | 分页拉取起始下标 |
count | number | 是 | 一页拉取的数量 |
operationID | string | 否 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse<GroupItem[]>> | 加入的群组列表 |
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.getJoinedGroupList({ offset: 0, count: 1000 })
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('getJoinedGroupList', operationID: string, {
offset: number;
count: number;
}): Promise<GroupItem[]>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
offset | number | 是 | 分页拉取起始下标 |
count | number | 是 | 一页拉取的数量 |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<GroupItem[]> | 加入的群组列表 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('getJoinedGroupList', IMSDK.uuid(), { offset: 0, count: 1000 })
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.getJoinedGroupList({
offset: number;
count: number;
}, operationID: string): Promise<GroupItem[]>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
offset | number | 是 | 分页拉取起始下标 |
count | number | 是 | 一页拉取的数量 |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<GroupItem[]> | 加入的群组列表 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.getJoinedGroupList({
offset: 0;
count: 1000;
}, 'operationID')
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});