Class default

Hierarchy

default

Index

Constructors

constructor

Properties

EmailVerificationClaim

Methods

Constructors

constructor

new default(): default

Returns default

Properties

Static EmailVerificationClaim

EmailVerificationClaim: EmailVerificationClaimClass = ...

Methods

Static getEmailVerificationTokenFromURL

getEmailVerificationTokenFromURL(input?: { userContext?: any }): string

- Defined in lib/ts/recipe/emailverification/index.ts:94
Parameters
- Optional input: { userContext?: any }
  - Optional userContext?: any
Returns string

Static init

init(config?: UserInput): CreateRecipeFunction<PreAndPostAPIHookAction>

- Defined in lib/ts/recipe/emailverification/index.ts:24
Parameters
- Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>

Static isEmailVerified

isEmailVerified(input?: { options?: RecipeFunctionOptions; userContext?: any }): Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK" }>

- Defined in lib/ts/recipe/emailverification/index.ts:83
Check if an email has been verified

throws
STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"

Parameters
- Optional input: { options?: RecipeFunctionOptions; userContext?: any }
  - Optional options?: RecipeFunctionOptions
  - Optional userContext?: any
Returns Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK" }>
{status: "OK", isVerified: boolean}

Static sendVerificationEmail

sendVerificationEmail(input?: { options?: RecipeFunctionOptions; userContext?: any }): Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR" }>

- Defined in lib/ts/recipe/emailverification/index.ts:62
Send an email to the user for verification.

throws
STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"

Parameters
- Optional input: { options?: RecipeFunctionOptions; userContext?: any }
  - Optional options?: RecipeFunctionOptions
  - Optional userContext?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR" }>
{status: "OK"} if successfull

Static verifyEmail

verifyEmail(input?: { options?: RecipeFunctionOptions; userContext?: any }): Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>

- Defined in lib/ts/recipe/emailverification/index.ts:40
Verify an email

throws
STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"

Parameters
- Optional input: { options?: RecipeFunctionOptions; userContext?: any }
  - Optional options?: RecipeFunctionOptions
  - Optional userContext?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>
{status: "OK"} if successfull

Generated using TypeDoc