@amityco/ts-sdk-react-native/dist/userRepository/relationship/follow/api/queryFollowers.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { queryFollowers } from '@amityco/ts-sdk-react-native'
 * const { data: followers, prevPage, nextPage } = await queryFollowers({ userId })
 * ```
 *
 * Queries a paginable list of {@link Amity.FollowStatus}
 *
 * @param query The query parameters
 * @returns followers
 *
 * @category Follow API
 * @async
 */
export declare const queryFollowers: {
    (query: Amity.QueryFollowers): Promise<Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>>>;
    /**
     * ```js
     * import { queryFollowers } from '@amityco/ts-sdk-react-native'
     * const { data: followers, prevPage, nextPage } = queryFollowers.locally({ userId })
     * ```
     *
     * Queries a paginable list of {@link Amity.FollowStatus} objects from cache
     *
     * @param query The query parameters
     * @returns followers
     *
     * @category Post API
     */
    locally(query: Parameters<typeof queryFollowers>[0]): Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>> | undefined;
};
//# sourceMappingURL=queryFollowers.d.ts.map