@amityco/ts-sdk-react-native
Version:
Amity Social Cloud Typescript SDK
36 lines • 1.19 kB
TypeScript
/**
*
* @deprecated This function will to be deprecated. Please use getGlobalFeed instead.
*
* ```js
* import { queryGlobalFeed } from '@amityco/ts-sdk-react-native'
* const posts = await queryGlobalFeed()
* ```
*
* Queries a paginable list of {@link Amity.Post} objects
*
* @param query The query parameters
* @returns A page of {@link Amity.Post} objects
*
* @category Feed API
* @async
* */
export declare const queryGlobalFeed: {
(query?: Amity.QueryGlobalFeed): Promise<Omit<Amity.Cached<Amity.Paged<Amity.Post> & Amity.Pagination>, 'nextPage' | 'prevPage'>>;
/**
* ```js
* import { queryGlobalFeed } from '@amityco/ts-sdk-react-native'
* const posts = await queryGlobalFeed.locally()
* ```
*
* Queries a paginable list of {@link Amity.Post} objects from cache
*
* @param query The query parameters
* @returns A page of {@link Amity.Post} objects
*
* @category Feed API
* @async
* */
locally(query?: Parameters<typeof queryGlobalFeed>[0]): Omit<Amity.Cached<Amity.Paged<Amity.Post> & Amity.Pagination>, 'nextPage' | 'prevPage'> | undefined;
};
//# sourceMappingURL=queryGlobalFeed.d.ts.map