Interface: AuthController<UserType>
Controller for retrieving the logged user or performing auth related operations
Type parameters​
| Name | Type |
|---|---|
UserType | extends User = User |
Properties​
authDelegate​
• authDelegate: AuthDelegate<UserType>
Delegate in charge of connecting to a backend and performing the auth operations.
Defined in​
authLoading​
• authLoading: boolean
If you have defined an Authenticator, this flag will be set to true while it loads
Defined in​
canAccessMainView​
• canAccessMainView: boolean
Has the user completed the steps to access the main view, after the login screen
Defined in​
extra​
• Optional extra: any
Utility field you can use to store your custom data. e.g: Additional user data fetched from a Firestore document, or custom claims
Defined in​
initialLoading​
• initialLoading: boolean
Initial loading flag. It is used not to display the login screen when the app first loads and it has not been checked whether the user is logged in or not.
Defined in​
loginSkipped​
• Optional loginSkipped: boolean
Has the user skipped the login process
Defined in​
notAllowedError​
• notAllowedError: any
The current user was not allowed access
Defined in​
user​
• user: null | UserType
The user currently logged in The values can be: the user object, null if they skipped login
Defined in​
Methods​
setExtra​
â–¸ setExtra(extra): void
You can use this method to store any extra data you would like to associate your user to. e.g: Additional user data fetched from a Firestore document, or custom claims
Parameters​
| Name | Type |
|---|---|
extra | any |
Returns​
void
Defined in​
signOut​
â–¸ signOut(): void
Sign out
Returns​
void