Class FRUser

High-level API for logging a user in/out and getting profile information.

Hierarchy

FRUser

Index

Methods

Methods

Static login

login<T>(handler: FRStepHandler, options?: ConfigOptions): Promise<FRStep | T>

- Defined in packages/javascript-sdk/src/fr-user/index.ts:31
Logs the user in with the specified step handler, acquires OAuth tokens, and retrieves user profile. Currently not implemented.

Type parameters
- T
  
  The type of user object expected
Parameters
- handler: FRStepHandler
  
  The function to invoke when handling authentication steps
- Optional options: ConfigOptions
  
  Configuration overrides
Returns Promise<FRStep | T>

Static loginWithUI

loginWithUI<T>(ui: FRUI, options?: ConfigOptions): Promise<T>

- Defined in packages/javascript-sdk/src/fr-user/index.ts:46
Logs the user in with the specified UI, acquires OAuth tokens, and retrieves user profile.

Type parameters
- T
  
  The type of user object expected
Parameters
- ui: FRUI
  
  The UI instance to use to acquire a session
- Optional options: ConfigOptions
  
  Configuration overrides
Returns Promise<T>

Static logout

logout(options?: ConfigOptions): Promise<void>

- Defined in packages/javascript-sdk/src/fr-user/index.ts:62
Ends the user's session and revokes OAuth tokens.

Parameters
- Optional options: ConfigOptions
  
  Configuration overrides
Returns Promise<void>