Authentication StateAPI
API
The API for interacting with authentication state.
Anchor to orderstatusapiOrderStatusApi
The API object provided to this and other customer-account.order-status extension targets.
- Anchor to authenticationStateauthenticationStateStatefulRemoteSubscribable<>required
The authentication state of Order status page.
Docs_OrderStatus_AuthenticationStateApi
- authenticationState
The authentication state of Order status page.
StatefulRemoteSubscribable<AuthenticationState>
export interface Docs_OrderStatus_AuthenticationStateApi
extends Pick<OrderStatusApi<any>, 'authenticationState'> {}AuthenticationState
'fully_authenticated' | 'pre_authenticated'Was this section helpful?
Anchor to useAuthenticationStateuse
use
Returns authentication state of Order status page.
"fully_authenticated" | "pre_authenticated"
UseAuthenticationStateGeneratedType
Returns authentication state of Order status page.
"fully_authenticated" | "pre_authenticated"export function useAuthenticationState<
Target extends RenderOrderStatusExtensionTarget = RenderOrderStatusExtensionTarget,
>(): AuthenticationState {
return useSubscription(useApi<Target>().authenticationState);
}Was this section helpful?