Interface ClientAuthenticator<Credential, Data, Context>

Type parameters

Credential
Data
Context: AnyAuthContext

Hierarchy

ClientAuthenticator
- WebviewClientAuthenticator

Index

Properties

platform

Methods

Properties

platform

platform: string

Methods

checkAuthData

checkAuthData(data: Data): CheckDataResult<Context>

- Defined in packages/auth/src/types.ts:157
Called before the authorization finish, you can make some simple non-async final checks. Return the auth context supplement if success.

Parameters
- data: Data
Returns CheckDataResult<Context>

fetchCredential

fetchCredential(entry: string): Promise<AuthenticatorCredentialResult<Credential>>

- Defined in packages/auth/src/types.ts:149
Start work flow from client side and resolve the auth data which would be then verified and signed at server side. If the auth flow reuqire redirecting user-agent, just set the location and pend resolving.

Parameters
- entry: string
Returns Promise<AuthenticatorCredentialResult<Credential>>

init

init(authEntry: string, errorFromServer: null | AuthError, dataFromServer: null | Data): Promise<void>

- Defined in packages/auth/src/types.ts:138
Initiate necessary libary like IdP SDK to start authentication works, this method is expected to be called before the view of app start rendering and would only be called once.

Parameters
- authEntry: string
- errorFromServer: null | AuthError
- dataFromServer: null | Data
Returns Promise<void>

Generated using TypeDoc