Class AuthProvider

Hierarchy

AuthProvider

Index

Constructors

constructor

Properties

appId

Accessors

Methods

Constructors

constructor

new AuthProvider(clientId: string, p?: Partial<ConstructorParams>): AuthProvider

- Defined in src/index.ts:51
Parameters
- clientId: string
- Optional p: Partial<ConstructorParams>
Returns AuthProvider

Properties

appId

appId: string

Accessors

connected

get connected(): boolean

- Defined in src/index.ts:223
Returns boolean

logo

get logo(): { horizontal: string; vertical: string }

- Defined in src/index.ts:425
Returns { horizontal: string; vertical: string }
- horizontal: string
- vertical: string

theme

get theme(): Theme

- Defined in src/index.ts:432
Returns Theme

Methods

canReconnect

canReconnect(): Promise<boolean>

- Defined in src/index.ts:302
A function to to be called before trying to .reconnect()

Returns Promise<boolean>

connect

connect(): Promise<EthereumProvider>

- Defined in src/index.ts:126
A function to open login plug n play modal

Returns Promise<EthereumProvider>

getLogins

getLogins(): Promise<Logins[]>

- Defined in src/index.ts:281
A function to request list of available logins

Returns Promise<Logins[]>

getProvider

getProvider(): ArcanaProvider

- Defined in src/index.ts:292
A function to get web3 provider

deprecated
use .provider instead

Returns ArcanaProvider

getPublicKey

getPublicKey(email: string, verifier?: Logins): Promise<string>

- Defined in src/index.ts:265
A function to request public key of other users

NOTE: Currently does not work by default for most applications. MFA availability (which is enabled by default) has to be disabled for this to work.

Parameters
- email: string
- verifier: Logins = 'google'
Returns Promise<string>

getUser

getUser(): Promise<UserInfo>

- Defined in src/index.ts:231
A function to get user info for the logged-in user

Returns Promise<UserInfo>
available user info

init

init(): Promise<AuthProvider>

- Defined in src/index.ts:83
A function to initialize the wallet, should be called before getting provider

Returns Promise<AuthProvider>

isLoggedIn

isLoggedIn(): Promise<boolean>

- Defined in src/index.ts:241
A function to determine whether the user is logged in

Returns Promise<boolean>

loginWithBearer

loginWithBearer(type: firebase, data: FirebaseBearer): Promise<boolean>

- Defined in src/index.ts:213
Parameters
- type: firebase
- data: FirebaseBearer
Returns Promise<boolean>

loginWithLink

loginWithLink(email: string, emailSentHook?: (() => void)): Promise<EthereumProvider>

- Defined in src/index.ts:192
A function to trigger passwordless login in the wallet

Parameters
- email: string
- Optional emailSentHook: (() => void)
  - - (): void
    - Returns void
Returns Promise<EthereumProvider>

loginWithSocial

loginWithSocial(loginType: string): Promise<EthereumProvider>

- Defined in src/index.ts:175
A function to trigger social login in the wallet

Parameters
- loginType: string
Returns Promise<EthereumProvider>

logout

logout(): Promise<void>

- Defined in src/index.ts:252
A function to log out the user

Returns Promise<void>

reconnect

reconnect(): Promise<void>

- Defined in src/index.ts:325
A function to try to reconnect to last login session. Should be called on event of click function as it opens a popup.

Returns Promise<void>

showWallet

showWallet(): void

- Defined in src/index.ts:165
A function to show wallet

Returns void

Generated using TypeDoc, the 10/11/2023 at 10:56:20 AM