Class AuthProvider

Hierarchy

AuthProvider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AuthProvider(params: InitParams): AuthProvider

- Defined in index.ts:131
Parameters
- params: InitParams
Returns AuthProvider

Properties

appConfig

appConfig: AppConfigType

initialized

initialized: boolean = false

Methods

getAvailableLogins

getAvailableLogins(): Promise<SocialLoginType[]>

- Defined in index.ts:519
A helper method to get list of available logins

Returns Promise<SocialLoginType[]>

getPublicKey

getPublicKey(input: KeystoreInput, output?: PublicKeyOutput): Promise<string | { x: string; y: string }>

- Defined in index.ts:565
A method to get public key for other users

Parameters
- input: KeystoreInput
- output: PublicKeyOutput = PublicKeyOutput.uncompressed
Returns Promise<string | { x: string; y: string }>
returns object or string based on output option provided

getUserInfo

getUserInfo(): GetInfoOutput

- Defined in index.ts:527
A method to get user info, if logged in

Returns GetInfoOutput

handleRedirect

handleRedirect(): Promise<undefined | (() => Promise<void>)>

- Defined in index.ts:581
Returns Promise<undefined | (() => Promise<void>)>

init

init(): Promise<void>

- Defined in index.ts:731
Returns Promise<void>

isLoggedIn

isLoggedIn(): boolean

- Defined in index.ts:542
A helper method to determine whether user is logged in

Returns boolean

loginWithOtp

loginWithOtp(email: string, options?: PasswordlessOptions): Promise<void | { state: string; url: string } | (OtpLoginResponse & { state: string })>

- Defined in index.ts:458
deprecated
A method to trigger passwordless login

Parameters
- email: string
- options: PasswordlessOptions = ...
Returns Promise<void | { state: string; url: string } | (OtpLoginResponse & { state: string })>
returns OAuth URL if autoRedirect is set to false, object if withUI is set to false

loginWithPasswordless

loginWithPasswordless(__namedParameters: { code: string; email: string }): Promise<void>

- Defined in index.ts:415
Parameters
- __namedParameters: { code: string; email: string }
  - code: string
  - email: string
Returns Promise<void>

loginWithPasswordlessStart

loginWithPasswordlessStart(params: Partial<{ email: string; kind: "link" | "otp"; state: string }>): Promise<PasswordlessLoginResponse>

- Defined in index.ts:359
Parameters
- params: Partial<{ email: string; kind: "link" | "otp"; state: string }>
Returns Promise<PasswordlessLoginResponse>

loginWithPasswordlessV2Complete

loginWithPasswordlessV2Complete(__namedParameters: { email: string; otp: string }): Promise<void>

- Defined in index.ts:326
Parameters
- __namedParameters: { email: string; otp: string }
  - email: string
  - otp: string
Returns Promise<void>

loginWithPasswordlessV2Start

loginWithPasswordlessV2Start(params: Partial<{ email: string; kind: "link" | "otp"; state: string }>): Promise<void | { state: string; url: string }>

- Defined in index.ts:280
Parameters
- params: Partial<{ email: string; kind: "link" | "otp"; state: string }>
Returns Promise<void | { state: string; url: string }>

loginWithSocial

loginWithSocial(loginType: google | discord | twitch | github | twitter | passwordlessV2 | steam | aws): Promise<void | { state: string; url: string }>

- Defined in index.ts:239
A method to trigger social login

Parameters
- loginType: google | discord | twitch | github | twitter | passwordlessV2 | steam | aws
Returns Promise<void | { state: string; url: string }>
returns authorization URL and state if autoRedirect is set to false

logout

logout(): void

- Defined in index.ts:550
A method to logout the user

Returns void

Static fromGlobalRedirect

fromGlobalRedirect(p: Partial<InitParams>): Promise<{ appId: string; provider: AuthProvider; state: string; cleanup?: any }>

- Defined in index.ts:75
Parameters
- p: Partial<InitParams>
Returns Promise<{ appId: string; provider: AuthProvider; state: string; cleanup?: any }>

Static handleRedirectPage

handleRedirectPage(origin: string): void

- Defined in index.ts:119
helper function to handle redirect params on popup mode

Parameters
- origin: string
Returns void

Static init

init(params: InitParams): Promise<AuthProvider>

- Defined in index.ts:110
helper function to initialize the AuthProvider, should be the starting point

Parameters
- params: InitParams
Returns Promise<AuthProvider>

Generated using TypeDoc, the 2/12/2024 at 7:15:57 PM