Files
firecms/website/docs/api/interfaces/authcontroller.md
2021-06-06 13:36:47 +02:00

3.5 KiB

id, title, sidebar_label, sidebar_position, custom_edit_url
id title sidebar_label sidebar_position custom_edit_url
authcontroller Interface: AuthController AuthController 0 null

Properties

authLoading

authLoading: boolean

Is the login process ongoing

Defined in

contexts/AuthContext.tsx:40


authProviderError

authProviderError: any

Error dispatched by the auth provider

Defined in

contexts/AuthContext.tsx:29


canAccessMainView

canAccessMainView: boolean

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

Defined in

contexts/AuthContext.tsx:24


extra

Optional extra: any

Utility field you can use to store your custom data. e.g: Additional user data fetched from a Firestore document

Defined in

contexts/AuthContext.tsx:72


loggedUser

loggedUser: null | User

The Firebase user currently logged in Either the Firebase user, null if they skipped login or undefined if they are in the login screen

Defined in

contexts/AuthContext.tsx:18


loginSkipped

loginSkipped: boolean

Is the login skipped

Defined in

contexts/AuthContext.tsx:51


notAllowedError

notAllowedError: boolean

The current user was not allowed access

Defined in

contexts/AuthContext.tsx:56


setAuthLoading

setAuthLoading: (loading: boolean) => void

param

Type declaration

▸ (loading): void

Parameters
Name Type
loading boolean
Returns

void

Defined in

contexts/AuthContext.tsx:46


setAuthProviderError

setAuthProviderError: (error: any) => void

Set an auth provider error

param

Type declaration

▸ (error): void

Parameters
Name Type
error any
Returns

void

Defined in

contexts/AuthContext.tsx:35


setExtra

setExtra: (extra: any) => void

Set extra

Type declaration

▸ (extra): void

Parameters
Name Type
extra any
Returns

void

Defined in

contexts/AuthContext.tsx:77


signOut

signOut: () => void

Sign out

Type declaration

▸ (): void

Returns

void

Defined in

contexts/AuthContext.tsx:66


skipLogin

skipLogin: () => void

Skip login

Type declaration

▸ (): void

Returns

void

Defined in

contexts/AuthContext.tsx:61