Interface RecipeInterface

Hierarchy

RecipeInterface

Index

Methods

Methods

getOAuthAuthorisationURL

getOAuthAuthorisationURL(input: { config: NormalisedConfig; thirdPartyId: string }): Promise<string>

- Defined in lib/ts/recipe/thirdparty/types.ts:155
Parameters
- input: { config: NormalisedConfig; thirdPartyId: string }
  - config: NormalisedConfig
  - thirdPartyId: string
Returns Promise<string>

getOAuthState

getOAuthState(): undefined | StateObject

- Defined in lib/ts/recipe/thirdparty/types.ts:145
Returns undefined | StateObject

redirectToThirdPartyLogin

redirectToThirdPartyLogin(input: { config: NormalisedConfig; state?: StateObject; thirdPartyId: string }): Promise<{ status: "OK" | "ERROR" }>

- Defined in lib/ts/recipe/thirdparty/types.ts:149
Parameters
- input: { config: NormalisedConfig; state?: StateObject; thirdPartyId: string }
  - config: NormalisedConfig
  - Optional state?: StateObject
  - thirdPartyId: string
Returns Promise<{ status: "OK" | "ERROR" }>

setOAuthState

setOAuthState(state: StateObject): void

- Defined in lib/ts/recipe/thirdparty/types.ts:147
Parameters
- state: StateObject
Returns void

signInAndUp

signInAndUp(input: { config: NormalisedConfig; thirdPartyId: string }): Promise<{ createdNewUser: boolean; status: "OK"; user: User } | { status: "NO_EMAIL_GIVEN_BY_PROVIDER" | "GENERAL_ERROR" } | { error: string; status: "FIELD_ERROR" }>

- Defined in lib/ts/recipe/thirdparty/types.ts:157
Parameters
- input: { config: NormalisedConfig; thirdPartyId: string }
  - config: NormalisedConfig
  - thirdPartyId: string
Returns Promise<{ createdNewUser: boolean; status: "OK"; user: User } | { status: "NO_EMAIL_GIVEN_BY_PROVIDER" | "GENERAL_ERROR" } | { error: string; status: "FIELD_ERROR" }>

Generated using TypeDoc