@amityco/ts-sdk-react-native/dist/subChannelRepository/api/querySubChannels.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { querySubChannels } from '@amityco/ts-sdk-react-native'
 * const subChannels = await querySubChannels({ channelId: 'channelId' })
 * ```
 *
 * Queries a paginable list of {@link Amity.SubChannel} objects
 *
 * @param query The query parameters
 * @returns A page of {@link Amity.SubChannel} objects
 *
 * @category Channel API
 * @async
 */
export declare const querySubChannels: {
    (query: Amity.QuerySubChannels): Promise<Amity.Cached<Amity.Paged<Amity.SubChannel>> & Amity.Pagination>;
    /**
     * ```js
     * import { querySubChannels } from '@amityco/ts-sdk-react-native'
     * const subChannels = querySubChannels.locally({ channelId: 'channelId' })
     * ```
     *
     * Queries a paginable list of {@link Amity.SubChannel} objects from cache
     *
     * @param query The query parameters
     * @returns sub channels
     *
     * @category Channel API
     */
    locally(query: Parameters<typeof querySubChannels>[0]): Amity.Cached<Amity.Paged<Amity.SubChannel> & Amity.Pagination> | undefined;
};
//# sourceMappingURL=querySubChannels.d.ts.map