Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default<GetRedirectionURLContextType, Action, OnHandleEventContextType, N> Abstract

Type Parameters

  • GetRedirectionURLContextType

  • Action

  • OnHandleEventContextType

  • N extends NormalisedConfig<GetRedirectionURLContextType, Action, OnHandleEventContextType>

Hierarchy

  • BaseRecipeModule<GetRedirectionURLContextType, Action, OnHandleEventContextType, N>

Index

Constructors

Properties

Methods

Constructors

constructor

  • new default<GetRedirectionURLContextType, Action, OnHandleEventContextType, N>(config: NormalisedConfigWithAppInfoAndRecipeID<N>): default<GetRedirectionURLContextType, Action, OnHandleEventContextType, N>

  • Type Parameters

    • GetRedirectionURLContextType

    • Action

    • OnHandleEventContextType

    • N extends NormalisedConfig<GetRedirectionURLContextType, Action, OnHandleEventContextType>

    Parameters

    • config: NormalisedConfigWithAppInfoAndRecipeID<N>

    Returns default<GetRedirectionURLContextType, Action, OnHandleEventContextType, N>

Properties

config

config: NormalisedConfigWithAppInfoAndRecipeID<N>

Abstract recipeID

recipeID: string

Methods

getDefaultRedirectionURL

  • getDefaultRedirectionURL(_: NormalisedGetRedirectionURLContext<GetRedirectionURLContextType>, _userContext: UserContext): Promise<string>

getRedirectUrl

  • getRedirectUrl(context: NormalisedGetRedirectionURLContext<GetRedirectionURLContextType>, userContext: UserContext): Promise<null | string>

redirect

  • redirect(context: NormalisedGetRedirectionURLContext<GetRedirectionURLContextType>, navigate: undefined | Navigate, queryParams?: Record<string, string>, userContext?: UserContext): Promise<void>

  • Parameters

    • context: NormalisedGetRedirectionURLContext<GetRedirectionURLContextType>
    • navigate: undefined | Navigate
    • Optional queryParams: Record<string, string>
    • Optional userContext: UserContext

    Returns Promise<void>

Generated using TypeDoc