Class AppleProvider

Hierarchy

BaseProvider
- AppleProvider

Index

Constructors

Properties

Methods

authenticate getAuthMethodId signIn

Constructors

constructor

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

Properties

redirectUri

redirectUri: string

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

Methods

authenticate

authenticate(): 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
Returns Promise<AuthMethod>
Inherited from BaseProvider.authenticate
- Defined in packages/lit-auth-client/src/lib/providers/AppleProvider.ts:45

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/AppleProvider.ts:106

signIn

signIn(): Promise<void>
Redirect user to the Lit's Apple login page

Returns
- Redirects user to Lit login page
Returns Promise<void>
- Defined in packages/lit-auth-client/src/lib/providers/AppleProvider.ts:33

Generated using TypeDoc