@amityco/ts-sdk-react-native/dist/userRepository/api/queryUsers.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { queryUsers } from '@amityco/ts-sdk-react-native'
 * const { data: users, prevPage, nextPage } = await queryUsers({ displayName: 'foo' })
 * ```
 *
 * Queries a paginable list of {@link Amity.User} objects
 * Search is performed by displayName such as `.startsWith(search)`
 *
 * @param query The query parameters
 * @returns A page of {@link Amity.User} objects
 *
 * @category User API
 * @async
 */
export declare const queryUsers: {
    (query?: Amity.QueryUsers): Promise<Amity.Cached<Amity.PageToken<Amity.User>>>;
    /**
     * ```js
     * import { queryUsers } from '@amityco/ts-sdk-react-native'
     * const { data: users } = queryUsers.locally({ keyword: 'foo' })
     * ```
     *
     * Queries a paginable list of {@link Amity.User} objects from cache
     * Search is performed by displayName such as `.startsWith(search)`
     *
     * @param query The query parameters
     * @returns A page of {@link Amity.User} objects
     *
     * @category User API
     */
    locally(query?: Parameters<typeof queryUsers>[0]): Amity.Cached<Amity.PageToken<Amity.User>> | undefined;
};
//# sourceMappingURL=queryUsers.d.ts.map