@amityco/ts-sdk-react-native/dist/messageRepository/api/getDeliveredUsers.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { getDeliveredUsers } from '@amityco/ts-sdk-react-native'
 * const { data: users, prevPage, nextPage } = await getDeliveredUsers({
 *   messageId: 'foo',
 * })
 * ```
 *
 * Queries a paginable list of delivered {@link Amity.InternalUser} by messageId
 *
 * @param query The query parameters
 * @returns A page of {@link Amity.InternalUser} objects
 *
 * @category Message API
 * @async
 */
export declare const getDeliveredUsers: {
    (query: Amity.QueryDeliveredUsers): Promise<Amity.Cached<Amity.Paged<Amity.InternalUser>>>;
    /**
     * ```js
     * import { getDeliveredUsers } from '@amityco/ts-sdk-react-native'
     * const { data: users } = getDeliveredUsers.locally({
     *   messageId: 'foo',
     * })
     * ```
     *
     * Queries a paginable list of delivered {@link Amity.InternalUser} objects from cache
     *
     * @param query The query parameters
     * @returns A page of {@link Amity.InternalUser} objects
     *
     * @category Message API
     */
    locally(query: Amity.QueryDeliveredUsers): Amity.Cached<Amity.Paged<Amity.InternalUser>> | undefined;
};
//# sourceMappingURL=getDeliveredUsers.d.ts.map