• Preparing search index...
  • The search index is not available
@salesforce/commerce-sdk-react
  • @salesforce/commerce-sdk-react
  • useAuthHelper

Function useAuthHelper

  • useAuthHelper<Mutation>(mutation): UseMutationResult<ReturnType<Auth[Mutation]> extends Promise<infer Data>
        ? Data
        : never, unknown, [] extends Parameters<Auth[Mutation]>
        ? void
        : Parameters<Auth[Mutation]>[0], unknown>
  • A hook for Public Client OAuth helpers.

    The hook calls the SLAS helpers imported from commerce-sdk-isomorphic. For more, see https://github.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/#public-client-shopper-login-helpers

    Avaliable helpers:

    • authorizeIDP
    • loginIDPUser
    • loginRegisteredUserB2C
    • loginGuestUser
    • logout
    • register
    • updateCustomerPassword

    Type Parameters

    • Mutation extends AuthHelper

    Parameters

    • mutation: Mutation

    Returns UseMutationResult<ReturnType<Auth[Mutation]> extends Promise<infer Data>
        ? Data
        : never, unknown, [] extends Parameters<Auth[Mutation]>
        ? void
        : Parameters<Auth[Mutation]>[0], unknown>

    • Defined in src/hooks/useAuthHelper.ts:73

Settings

Member Visibility

Theme

@salesforce/commerce-sdk-react
  • Components
    • CommerceApiProvider
  • Helpers
    • DNT
      • useDNT
    • Other
      • useCommerceApi
    • Shopper Authentication
      • AuthHelpers
      • AuthHelper
      • useAccessToken
      • useAuthHelper
      • useCustomerId
      • useCustomerType
      • useEncUserId
      • useTrustedAgent
      • useUsid
  • ShopperBaskets
    • Mutation
      • ShopperBasketsMutations
      • ShopperBasketsMutation
      • useShopperBasketsMutation
    • Query
      • useBasket
      • usePaymentMethodsForBasket
      • usePriceBooksForBasket
      • useShippingMethodsForShipment
      • useTaxesFromBasket
  • ShopperContexts
    • Mutation
      • ShopperContextsMutations
      • ShopperContextsMutation
      • useShopperContextsMutation
    • Query
      • useShopperContext
  • ShopperCustomers
    • Mutation
      • ShopperCustomersMutations
      • ShopperCustomersMutation
      • useShopperCustomersMutation
    • Query
      • useCustomer
      • useCustomerAddress
      • useCustomerBaskets
      • useCustomerOrders
      • useCustomerPaymentInstrument
      • useCustomerProductList
      • useCustomerProductListItem
      • useCustomerProductLists
      • useProductListItem
      • usePublicProductList
      • usePublicProductListsBySearchTerm
  • ShopperExperience
    • Query
      • usePage
      • usePages
  • ShopperGiftCertificates
    • Query
      • useGiftCertificate
  • ShopperLogin
    • Mutation
      • ShopperLoginMutations
      • ShopperLoginMutation
      • useShopperLoginMutation
    • Query
      • useJwksUri
      • useUserInfo
      • useWellknownOpenidConfiguration
  • ShopperOrders
    • Mutation
      • ShopperOrdersMutations
      • ShopperOrdersMutation
      • useShopperOrdersMutation
    • Query
      • useOrder
      • usePaymentMethodsForOrder
      • useTaxesFromOrder
  • ShopperProducts
    • Query
      • useCategories
      • useCategory
      • useProduct
      • useProducts
  • ShopperPromotions
    • Query
      • usePromotions
      • usePromotionsForCampaign
  • ShopperSearch
    • Query
      • useProductSearch
      • useSearchSuggestions
  • Functions
    • useConfig
    • useCustomMutation
    • useCustomQuery
    • useShopperBasketsMutationHelper
  • Interfaces
    • ApiClients
    • SDKClientTransformConfig
  • Modules
    • <internal>
  • SearchStores
    • Query
      • useSearchStores
      • useStores
  • ShopperSEO
    • Query
      • useUrlMapping
  • Type Aliases
    • ApiClient
    • ApiClientConfigParams
    • ApiMethod
    • ApiOptions
    • ApiQueryKey
    • ApiQueryOptions
    • Argument
    • CacheUpdate
    • CacheUpdateGetter
    • CacheUpdateInvalidate
    • CacheUpdateMatrix
    • CacheUpdateRemove
    • CacheUpdateUpdate
    • DataType
    • ErrorCallback
    • ExcludeTail
    • MergedOptions
    • NullToOptional
    • NullableParameters
    • OmitNullableParameters
    • OptionalCustomEndpointClientConfig
    • Prettify
    • RemoveStringIndex
    • RequireKeys
    • SDKClientTransformer
    • TMutationVariables
    • Tail
    • useCustomerType