Class EmailVerificationClaimClass

We include "Class" in the class name, because it makes it easier to import/use the right thing (the instance exported by the recipe) instead of this.

Hierarchy

BooleanClaim
- EmailVerificationClaimClass

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new EmailVerificationClaimClass(getRecipeImpl: () => RecipeInterface, updateContextOnIsVerifiedFalse?: (userContext: any) => void | Promise<void>): EmailVerificationClaimClass

Overrides BooleanClaim.constructor
- Defined in lib/ts/recipe/emailverification/emailVerificationClaim.ts:8
Parameters
- getRecipeImpl: () => RecipeInterface
  - - (): RecipeInterface
    - Returns RecipeInterface
- Optional updateContextOnIsVerifiedFalse: (userContext: any) => void | Promise<void>
  - - (userContext: any): void | Promise<void>
    - Parameters
      - userContext: any
      Returns void | Promise<void>
Returns EmailVerificationClaimClass

Properties

Readonly defaultMaxAgeInSeconds

defaultMaxAgeInSeconds: undefined | number

Readonly id

id: string

Readonly refresh

refresh: (userContext: any) => Promise<void>

Type declaration

- (userContext: any): Promise<void>
- Makes an API call that will refresh the claim in the token.
  
  Parameters
  - userContext: any
  Returns Promise<void>

validators

validators: { hasValue: any } & BooleanValidators & { isVerified: any }

Methods

getLastFetchedTime

getLastFetchedTime(payload: any, _userContext?: any): undefined | number

Inherited from BooleanClaim.getLastFetchedTime
- Defined in node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:13
Parameters
- payload: any
- Optional _userContext: any
Returns undefined | number

getValueFromPayload

getValueFromPayload(payload: any, _userContext?: any): boolean

Inherited from BooleanClaim.getValueFromPayload
- Defined in node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:12
Parameters
- payload: any
- Optional _userContext: any
Returns boolean

Generated using TypeDoc