synapse-react-client/dist/synapse-queries/user/useUserGroupHeader.d.ts

[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie

import { SynapseClientError } from '@sage-bionetworks/synapse-client';
import { TYPE_FILTER, UserGroupHeader } from '@sage-bionetworks/synapse-types';
import { UseQueryOptions } from '@tanstack/react-query';
/**
 * Get a single UserGroupHeader, utilizing a react-query cache.  This is always an unauthenticated call
 * (the user's current email address will never be returned in the result).
 * @param principalId
 * @param options
 * @returns
 */
export declare function useGetUserGroupHeader(principalId: string, options?: Partial<UseQueryOptions<UserGroupHeader, SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<UserGroupHeader, SynapseClientError>;
/**
 * Get an array of UserGroupHeaders, utilizing a react-query cache.  This is always an unauthenticated call
 * (the users current email addresses will never be returned in the result).
 * @param principalIds
 * @param options
 * @returns
 */
export declare function useGetUserGroupHeaders(principalIds: string[], options?: Partial<UseQueryOptions<UserGroupHeader[], SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<UserGroupHeader[], SynapseClientError>;
export declare function useSearchUserGroupHeaders(prefix: string, filter?: TYPE_FILTER, options?: Partial<UseQueryOptions<UserGroupHeader[], SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<UserGroupHeader[], SynapseClientError>;
export declare function useGetUserGroupHeaderWithAlias(aliases: string[], options?: Partial<UseQueryOptions<UserGroupHeader[], SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<UserGroupHeader[], SynapseClientError>;
//# sourceMappingURL=useUserGroupHeader.d.ts.map