katana_auth_firebase library
Firebase plugin for katana_auth. A package to facilitate switching between Local and Firebase authentication implementations.
To use, import package:katana_auth_firebase/katana_auth_firebase.dart
.
Classes
- AccessTokenValue
- Returns the result of an access token.
- AnonymouslyAuthQuery
-
An
AuthQuery
for anonymous authentication. - AnonymouslySignInAuthProvider
- AuthProvider for performing Authentication.signIn.
- Api
- Provides static methods for making HTTP requests.
- ApiMultipartFile
- A file to be uploaded as part of a ApiMultipartFile.
- AuthAction
- Base class that allows callbacks to be planted for sign-in and sign-out.
- AuthActionQuery
- Class for implementing callbacks from Authentication or AuthAdapter during authentication.
- AuthAdapter
- Adapters to change the behavior of authentication on different platforms.
- AuthAdapterScope
- Place it on top of MaterialApp, etc., and set AuthAdapter for the entire app.
- AuthDatabase
- A database for managing authentication information locally.
- Authentication
- Authentication implemented by AuthAdapter.
- AuthExporter
- Import and export DynamicMap data used in AuthDatabase to external files.
- AuthInitialValue
- Class for entering initial values for authentication information.
- AuthProvider
- An adapter used to execute various methods of Authentication.
- ChangeAuthProvider
- AuthProvider for performing Authentication.change.
- ChangeEmailAuthProvider
- AuthProvider for performing Authentication.change.
- ChangePasswordAuthProvider
- AuthProvider for performing Authentication.change.
- ChangePhoneNumberAuthProvider
- AuthProvider for performing Authentication.change.
- Clock
- A class that can be used instead of DateTime.
- ConfirmChangeAuthProvider
- AuthProvider for performing Authentication.confirmChange.
- ConfirmChangePhoneNumberAuthProvider
- AuthProvider for performing Authentication.confirmChange.
- ConfirmSignInAuthProvider
- AuthProvider for performing Authentication.confirmSignIn.
- ConsoleLoggerAdapter
- LoggerAdapter for outputting logs to the console.
- CreateAuthProvider
- AuthProvider for performing Authentication.create.
- Credential
- Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements.
- DateDuration
- A class that represents a date period.
- DateFormat
- DateFormat is for formatting and parsing dates in a locale-sensitive manner.
- DirectAuthQuery
-
An
AuthQuery
for debugging authentication. - DirectSignInAuthProvider
- AuthProvider for performing Authentication.signIn.
- EmailAndPasswordAuthQuery
-
An
AuthQuery
to authenticate by email and password. - EmailAndPasswordChangeEmailAuthProvider
- AuthProvider for performing Authentication.change.
- EmailAndPasswordChangePasswordAuthProvider
- AuthProvider for performing Authentication.change.
- EmailAndPasswordCreateAuthProvider
- AuthProvider for performing Authentication.create.
- EmailAndPasswordReAuthProvider
- AuthProvider for performing Authentication.reauth.
- EmailAndPasswordRegisterAuthProvider
- AuthProvider for performing Authentication.register.
- EmailAndPasswordResetAuthProvider
- AuthProvider for performing Authentication.reset.
- EmailAndPasswordSignInAuthProvider
- AuthProvider for performing Authentication.signIn.
- EmailAndPasswordVerifyAuthProvider
- AuthProvider for performing Authentication.verify.
- EmailLinkAuthQuery
-
An
AuthQuery
for link authentication via email. - EmailLinkChangeEmailAuthProvider
- AuthProvider for performing Authentication.change.
- EmailLinkConfirmSignInAuthProvider
- AuthProvider for performing Authentication.confirmSignIn.
- EmailLinkSignInAuthProvider
- AuthProvider for performing Authentication.signIn.
- EmailLinkVerifyAuthProvider
- AuthProvider for performing Authentication.verify.
- FirebaseAuthAdapter
- Model adapter with FirebaseAuth available.
- FirebaseCore
- Initialize Firebase.
- FirebaseOptions
- The options used to configure a Firebase app.
- FirebaseSnsReAuthProvider
-
An
AuthQuery
for OAuth re-authentication of SNS on Firebase. - FirebaseSnsSignInAuthProvider
-
An
AuthQuery
for OAuth authentication for SNS on Firebase. - Immutable
- Used to annotate a class.
- LocalAuthAdapter
- Authentication adapter that stores data on the local terminal.
- LocalLoggerAdapter
- Logging can be done locally on the terminal LoggerAdapter.
- Loggable
- Interface for objects that can be passed directly to Logger.send.
- Logger
- Used for active logging.
- LoggerAdapter
- Base class for defining platform adapters for storing logs.
- LoggerAdapterScope
- Place it on top of MaterialApp, etc., and set LoggerAdapter for the entire app.
- LoggerDatabase
- A simple database for logging information.
- LoggerExporter
- Import and export DynamicMap data used in LoggerDatabase to external files.
- LoggerTrace
- Base class for tracing logs and measuring performance.
- LoggerTraceValue
- Base class for tracing logs and measuring performance.
- LogValue
- Class for defining log values for viewing.
-
NumRange<
TNum extends num> - A class that represents a range of numbers.
- ReAuthProvider
- AuthProvider for performing Authentication.reauth.
-
RectRange<
TNum extends num> - A class that represents a range of numbers.
- RegisterAuthProvider
- AuthProvider for performing Authentication.register.
- ResetAuthProvider
- AuthProvider for performing Authentication.reset.
- RuntimeAuthAdapter
- Authentication adapter using a database that runs only in the app's memory.
- RuntimeLoggerAdapter
- Logging in memory LoggerAdapter.
- SignInAuthProvider
- AuthProvider for performing Authentication.signIn.
- SmsAuthQuery
-
An
AuthQuery
for SMS code authentication. - SmsChangePhoneNumberAuthProvider
- AuthProvider for performing Authentication.change.
- SmsConfirmChangePhoneNumberAuthProvider
- AuthProvider for performing Authentication.confirmChange.
- SmsConfirmSignInAuthProvider
- AuthProvider for performing Authentication.confirmSignIn.
- SmsSignInAuthProvider
- AuthProvider for performing Authentication.signIn.
- SnsReAuthProvider
-
An
AuthQuery
for OAuth re-authentication of SNS. - SnsSignInAuthProvider
-
An
AuthQuery
for OAuth authentication for SNS. - TestAuthAdapterScope
- Test scope for AuthAdapter.
- TestLoggerAdapterScope
- Test scope for LoggerAdapter.
- VerifyAuthProvider
- AuthProvider for performing Authentication.verify.
Enums
- ApiMethod
- An HTTP method.
- ApiMultipartFileType
- The type of the multipart file.
- AuthLoggerEvent
- Authentication events for logging.
- DayOfWeek
- Day of the week.
- FirebaseRegion
- Specify the Firebase region.
Extensions
- BooleanExtensions on bool
- Provides extended methods for bool.
- ClockExtensions on Clock
- Provides extended methods for Clock.
-
ClockIterableExtensions
on Iterable<
Clock> - Provides extended methods for Clock arrays.
- DateTimeExtensions on DateTime
- Provides extended methods for DateTime.
-
DateTimeIterableExtensions
on Iterable<
DateTime> - Provides extended methods for DateTime arrays.
- DoubleExtensions on double
- Provides extended methods for double.
-
DoubleIterableExtensions
on Iterable<
double> - Provides extended methods for double arrays.
- DurationExtensions on Duration
- Provides extended methods for Duration.
-
DynamicMapExtensions
on Map<
String, dynamic> - Provides extended methods for DynamicMap.
-
InterableOfIterableExtensions
on Iterable<
Iterable< T> > - Provides extended methods for Iterable arrays.
- IntExtensions on int
- Provides extended methods for int.
-
IntIterableExtensions
on Iterable<
int> - Provides extended methods for int arrays.
-
IterableExtensions
on Iterable<
T> -
Provides extended methods for
T
arrays. - JsonDynamicListExtensions on DynamicList
- Provides Json extension methods for DynamicList.
- JsonDynamicMapExtensions on DynamicMap
- Provides Json extension methods for DynamicMap.
-
ListExtensions
on List<
T> -
Provides extended methods for List in
T
. -
MapExtensions
on Map<
K, V> - Provides extended methods for Map.
- NullableDoubleExtensions on double?
- Provides an extension method for double that is nullable.
- NullableIntExtensions on int?
- Provides an extension method for int that is nullable.
-
NullableIterableExtensions
on Iterable<
T> ? - Provides an extension method for Iterable that is nullable.
-
NullableListExtensions
on List<
T> ? - Provides an extension method for List that is nullable.
-
NullableMapExtensions
on Map<
K, V> ? - Provides an extension method for Map that is nullable.
- NullableNumExtensions on num?
- Provides an extension method for num that is nullable.
- NullableObjectExtensions on Object?
- Provides an extension method for List that is nullable.
-
NullableSetExtensions
on Set<
T> ? - Provides an extension method for Set that is nullable.
- NullableStringExtensions on String?
- Provides an extension method for String that is nullable.
- NullableTExtensions on T?
-
Provides an extension method for
T?
that is nullable. - NullableUriExtensions on Uri?
- Provides an extension method for Uri that is nullable.
-
NullableValueIterableExtensions
on Iterable<
T?> - Provides an extension method for Iterable whose value is nullable.
- RandomExtensions on Random
- Provides extended methods for Random.
-
SetExtensions
on Set<
T> - Provides extended methods for Set.
- StringExtensions on String
- Provides extended methods for String.
- UriExtensions on Uri
- Provides extended methods for Uri.
Constants
- nullOfBool → const bool?
-
A
null
object with a defined type of bool? - nullOfDouble → const double?
-
A
null
object with a defined type of double? - nullOfDynamicList → const DynamicList?
-
A
null
object with a defined type of DynamicList? - nullOfDynamicMap → const DynamicMap?
-
A
null
object with a defined type of DynamicMap? - nullOfInt → const int?
-
A
null
object with a defined type of int? - nullOfNum → const num?
-
A
null
object with a defined type of num? - nullOfString → const String?
-
A
null
object with a defined type of String? - zeroOfNum → const num
-
A
0
object with a defined type of num?
Properties
- sprintf ↔ PrintFormat
-
getter/setter pair
Functions
-
generateCode(
int length, {int seed = 0, String charSet = "23456789abcdefghjkmnpqrstuvwxy"}) → String -
Generates and returns a random string with the number of characters given by
length
. -
initializeDateFormatting(
[String? locale, String? ignored]) → Future< void> -
This should be called for at least one
locale
before any date formatting methods are called. It sets up the lookup for date symbols. Both thelocale
andignored
parameter are ignored, as the data for all locales is directly available. -
jsonDecodeAsList<
T extends Object?> (String json, [List< T> defaultValue = const []]) → List<T> -
Converts
json
to a Json-decoded List<dynamic> object. -
jsonDecodeAsMap<
T extends Object?> (String json, [Map< String, T> defaultValue = const {}]) → Map<String, T> -
Converts
json
to a Json-decoded Map<String, dynamic> object. -
jsonEncodable(
Object? o) → bool -
If this object is Json encodable,
true
is returned. -
nullOfList<
T> () → List< T> ? -
A
null
object with a defined type of List<T>? -
nullOfMap<
K, V> () → Map< K, V> ? -
A
null
object with a defined type of Map<K, V>? -
nullOfSet<
T> () → Set< T> ? -
A
null
object with a defined type of Set<T>? -
uuid(
{DateTime? baseTime, bool reverse = false}) → String - Generate and retrieve the UUID for Version 7.
-
wait(
Iterable futures) → Future< void> -
Wait until all Futures given in
futures
are completed.
Typedefs
- ApiResponse = Response
- An HTTP response where the entire response body is known in advance.
- ApiResquest = Request
- An HTTP request where the entire request body is known in advance.
- DynamicList = List
- Represents the type of List<dynamic>.
-
DynamicMap
= Map<
String, dynamic> - Represents the type of Map<String, dynamic>.