stream-chat/dist/types/pagination/UserGroupPaginator.d.ts

JS SDK for the Stream Chat API

import { BasePaginator } from './BasePaginator';
import type { PaginationQueryParams, PaginationQueryReturnValue, PaginatorOptions, PaginatorState } from './BasePaginator';
import type { UserGroupResponse } from '../types';
import type { StreamChat } from '../client';
/**
 * Paginates user-group listing through `/usergroups`.
 *
 * This entity only supports forward cursor pagination via `created_at_gt` and `id_gt`.
 * Previous-page pagination is not available because the API does not expose a backward cursor.
 */
export declare class UserGroupPaginator extends BasePaginator<UserGroupResponse> {
    private client;
    protected _teamId: string | undefined;
    constructor(client: StreamChat, options?: PaginatorOptions);
    get initialState(): PaginatorState<UserGroupResponse>;
    get teamId(): string | undefined;
    set teamId(teamId: string | undefined);
    private buildNextCursor;
    query: ({ direction, }: PaginationQueryParams) => Promise<PaginationQueryReturnValue<UserGroupResponse>>;
    filterQueryResults: (items: UserGroupResponse[]) => UserGroupResponse[];
}