Skip to main content

Interface: AuthController

Controller for retrieving the logged user or performing auth related operations

Properties#

authDelegate#

authDelegate: AuthDelegate

Delegate in charge of connecting to a backend and performing the auth operations.

Defined in#

models/auth.tsx:57


canAccessMainView#

canAccessMainView: boolean

Has the user completed the steps to access the main view, after the login screen

Defined in#

models/auth.tsx:26


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#

models/auth.tsx:43


loginSkipped#

Optional loginSkipped: boolean

Has the user skipped the login process

Defined in#

models/auth.tsx:20


notAllowedError#

notAllowedError: any

The current user was not allowed access

Defined in#

models/auth.tsx:31


setExtra#

setExtra: (extra: any) => 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

Type declaration#

▸ (extra): void

Parameters#
NameType
extraany
Returns#

void

Defined in#

models/auth.tsx:51


signOut#

signOut: () => void

Sign out

Type declaration#

▸ (): void

Returns#

void

Defined in#

models/auth.tsx:36


user#

user: null | User

The user currently logged in The values can be: the user object, null if they skipped login

Defined in#

models/auth.tsx:15