@amityco/ts-sdk-react-native/dist/channelRepository/channelMembership/api/queryChannelMembers.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { queryChannelMembers } from '@amityco/ts-sdk-react-native'
 * const channelMembers = await queryChannelMembers({ channelId: 'foo' })
 * ```
 *
 * Queries a paginable list of {@link Amity.ChannelUser} objects
 *
 * @param query The query parameters
 * @returns A page of {@link Amity.ChannelUser} objects
 *
 * @category Channel API
 * @async
 * */
export declare const queryChannelMembers: {
    (query: Amity.QueryChannelMembers): Promise<Amity.Cached<Amity.Paged<Amity.Membership<'channel'>>>>;
    /**
     * ```js
     * import { queryChannelMembers } from '@amityco/ts-sdk-react-native'
     * const channelMembers = await queryChannelMembers(query)
     * ```
     *
     * Queries a paginable list of {@link Amity.InternalPost} objects from cache
     *
     * @param query The query parameters
     * @returns posts
     *
     * @category Post API
     */
    locally(query: Parameters<typeof queryChannelMembers>[0]): Amity.Cached<Amity.Paged<Amity.Membership<'channel'>>> | undefined;
};
//# sourceMappingURL=queryChannelMembers.d.ts.map