@amityco/ts-sdk-react-native/dist/streamRepository/api/getStreams.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { getStreams } from '@amityco/ts-sdk-react-native'
 * const streams = await getStreams()
 * ```
 *
 * Queries a paginable list of {@link Amity.Stream} objects
 *
 * @param query The query parameters
 * @returns A page of {@link Amity.Stream} objects
 *
 * @category Stream API
 * @async
 */
export declare const getStreams: {
    (query?: {
        isLive?: boolean;
        statuses?: Amity.StreamStatus[];
        userPublicIds?: Amity.InternalUser['userId'][];
        sortBy?: 'lastCreated' | 'firstCreated';
        isDeleted?: Amity.Stream['isDeleted'];
        page?: Amity.Page;
    }): Promise<Amity.Cached<Amity.Paged<Amity.Stream>>>;
    /**
     * ```js
     * import { getStreams } from '@amityco/ts-sdk-react-native'
     * const streams = getStreams.locally()
     * ```
     *
     * Queries a paginable list of {@link Amity.Stream} objects from cache
     *
     * @param query The query parameters
     * @returns streams
     *
     * @category Stream API
     */
    locally(query: Parameters<typeof getStreams>[0]): void;
};
//# sourceMappingURL=getStreams.d.ts.map