modules/auth/auth library

Classes

ApiService
Service for
AuthGuard
Guard that checks if the user is authenticated.
AuthModule
Handles the authentication of users.
AuthRepository
UI state controller for authentication.
AuthService
Service for authenticating users.
InsuffcientPermissionsReason
If AuthException.reason is InsuffcientPermissionsReason, the user does not have the required permissions to use the webservice and thus is not allowed to authenticate.
LoginForm
A form prompting the user to input their credentials.
LoginScreen
Presents an authentication form to the user.
Token
A token to authenticate with a Webservice.
User
A user using the application.
UserDatasource
Datasource for fetching user data.
UserRepository
UI state controller for the current user.

Enums

UserCapability
Represents the different capabilities a user can possess within the application.
Vintage
Represents a "Jahrgang" (grade level or class year) in a high school context. Used to denote the year group (or class) of students within a high school.
Webservice
An API endpoint exposed by a moodle plugin.

Extensions

TokenExt on Set<Token>
Utility functions for Token sets.
UserCapabilitiesExtension on List<UserCapability>
Provides helper methods for List<UserCapability>.
UserCapabilityExtension on UserCapability
Provides helper methods for UserCapability.

Exceptions / Errors

ApiServiceException
An exception thrown when ApiService.callFunction fails.
AuthException
An exception thrown when AuthService.authenticate fails.