Class GoogleProvider

Hierarchy

BaseProvider
- GoogleProvider

Index

Constructors

constructor

new GoogleProvider(options: BaseProviderOptions & OAuthProviderOptions): GoogleProvider
Parameters
- options: BaseProviderOptions & OAuthProviderOptions
Returns GoogleProvider
Overrides BaseProvider.constructor
- Defined in packages/lit-auth-client/src/lib/providers/GoogleProvider.ts:25

Properties

redirectUri

redirectUri: string

The redirect URI that Lit's login server should send the user back to

Methods

authenticate

authenticate<T>(_?: T, urlCheckCallback?: ((currentUrl: string, redirectUri: string) => boolean)): Promise<AuthMethod>
Validate the URL parameters returned from Lit's login server and return the authentication data

Returns
- Auth method object that contains OAuth token
Type Parameters
- T extends BaseAuthenticateOptions
Parameters
- Optional _: T
- Optional urlCheckCallback: ((currentUrl: string, redirectUri: string) => boolean)
  - - (currentUrl: string, redirectUri: string): boolean
    - Parameters
      
      currentUrl: string
      
      redirectUri: string
      
      Returns boolean
Returns Promise<AuthMethod>
Inherited from BaseProvider.authenticate
- Defined in packages/lit-auth-client/src/lib/providers/GoogleProvider.ts:53

getAuthMethodId

getAuthMethodId(authMethod: AuthMethod): Promise<string>
Get auth method id that can be used to look up and interact with PKPs associated with the given auth method

Returns
- Auth method id
Parameters
- authMethod: AuthMethod
  
  Auth method object
Returns Promise<string>
Inherited from BaseProvider.getAuthMethodId
- Defined in packages/lit-auth-client/src/lib/providers/GoogleProvider.ts:176

signIn

signIn(callback?: ((url: string) => void)): Promise<void>
Redirect user to the Lit's Google login page

Returns
- Redirects user to Lit login page
Parameters
- Optional callback: ((url: string) => void)
  
  Optional callback to handle login URL
  - - (url: string): void
    - Parameters
      
      url: string
      
      Returns void
Returns Promise<void>
- Defined in packages/lit-auth-client/src/lib/providers/GoogleProvider.ts:36

signInUsingPopup

signInUsingPopup(baseURL: string): Promise<AuthMethod>
Sign in using popup window
Parameters
- baseURL: string
Returns Promise<AuthMethod>
- Defined in packages/lit-auth-client/src/lib/providers/GoogleProvider.ts:118

`Static` authMethodId

authMethodId(authMethod: AuthMethod): Promise<string>
Parameters
- authMethod: AuthMethod
Returns Promise<string>
- Defined in packages/lit-auth-client/src/lib/providers/GoogleProvider.ts:180

Class GoogleProvider

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: BaseProviderOptions & OAuthProviderOptions

Returns GoogleProvider

Properties

redirectUri

Methods

authenticate

Returns

Type Parameters

T extends BaseAuthenticateOptions

Parameters

Optional _: T

Optional urlCheckCallback: ((currentUrl: string, redirectUri: string) => boolean)

Parameters

currentUrl: string

redirectUri: string

Returns boolean

Returns Promise<AuthMethod>

getAuthMethodId

Returns

Parameters

authMethod: AuthMethod

Returns Promise<string>

signIn

Returns

Parameters

Optional callback: ((url: string) => void)

Parameters

url: string

Returns void

Returns Promise<void>

signInUsingPopup

Parameters

baseURL: string

Returns Promise<AuthMethod>

Static authMethodId

Parameters

authMethod: AuthMethod

Returns Promise<string>

Settings

Member Visibility

Theme

`Optional` _: T

`Optional` urlCheckCallback: ((currentUrl: string, redirectUri: string) => boolean)

`Optional` callback: ((url: string) => void)

`Static` authMethodId