useGetUserReferralStatus
Ce contenu n’est pas encore disponible dans votre langue.
useGetUserReferralStatus(
args?):UseQueryResult<UserReferralStatusType|null,FrakRpcError<undefined>>
Defined in: react/src/hook/useGetUserReferralStatus.ts:47
Hook that return a query to fetch the current user’s referral status on the current merchant
Returns null when the user’s identity cannot be resolved.
It’s a @tanstack/react-query!home | `tanstack` wrapper around the `getUserReferralStatus()` action
Parameters
Section titled “Parameters”Optional config object with query for customizing the underlying @tanstack/react-query!useQuery | `useQuery()`
cacheTime?
Section titled “cacheTime?”number
Time in ms to cache the result at the core SDK level. Default: 30_000 (30s). Set to 0 to disable.
query?
Section titled “query?”QueryOptions
Optional query options, see @tanstack/react-query!useQuery | `useQuery()` for more infos
Returns
Section titled “Returns”UseQueryResult<UserReferralStatusType | null, FrakRpcError<undefined>>
The query hook wrapping the getUserReferralStatus() action
The data result is a `UserReferralStatusType` or null
- `getUserReferralStatus()` for more info about the underlying action
- @tanstack/react-query!useQuery | `useQuery()` for more info about the useQuery options and response