firebase_dart library

Classes

ActionCodeInfo
A response from calling checkActionCode.
ActionCodeSettings
Interface that defines the required continue/state URL with optional Android and iOS bundle identifiers.
AdditionalUserInfo
A structure containing additional user information from a federated identity provider.
AuthCredential
Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements.
AuthProvider
A base class which all providers must extend.
ConfirmationResult
A result from a phone number sign-in, link, or reauthenticate call.
DatabaseReference
DatabaseReference represents a particular location in your Firebase Database and can be used for reading or writing data to that location.
DataSnapshot
A DataSnapshot contains data from a Firebase database location.
DownloadTask
A class which indicates an on-going download task.
EmailAuthCredential
The auth credential returned from calling EmailAuthProvider.credential.
EmailAuthProvider
A EmailAuthCredential can be created by calling EmailAuthProvider.credential with an email and password.
Event
Event encapsulates a DataSnapshot and possibly also the key of its previous sibling, which can be used to order the snapshots.
FacebookAuthCredential
The auth credential returned from calling FacebookAuthProvider.credential.
FacebookAuthProvider
This class should be used to either create a new Facebook credential with an access code, or use the provider to trigger user authentication flows.
Firebase
The entry point for accessing Firebase.
FirebaseApp
Represents a single Firebase app instance.
FirebaseAuth
The entry point of the Firebase Authentication SDK.
FirebaseDart
FirebaseDatabase
The entry point for accessing a Firebase Database.
FirebaseOptions
The options used to configure a Firebase app.
FirebaseStorage
FirebaseStorage is a service that supports uploading and downloading large objects to Google Cloud Storage.
FullMetadata
Metadata for a Reference. Metadata stores default attributes such as size and content type.
GithubAuthCredential
An AuthCredential for authenticating via github.com
GithubAuthProvider
This class should be used to either create a new GitHub credential with an access code, or use the provider to trigger user authentication flows.
GoogleAuthCredential
An AuthCredential for authenticating via google.com
GoogleAuthProvider
This class should be used to either create a new Google credential with an access code, or use the provider to trigger user authentication flows.
IdTokenResult
Interface representing ID token result obtained from getIdTokenResult. It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims.
ListOptions
The options FirebaseStoragePlatform.list accepts.
ListResult
Class returned as a result of calling a list method (list or listAll) on a Reference.
MultiFactor
Defines multi-factor related properties and operations pertaining to a User. This class acts as the main entry point for enrolling or un-enrolling second factors for a user, and provides access to their currently enrolled factors.
MultiFactorAssertion
Represents an assertion that the Firebase Authentication server can use to authenticate a user as part of a multi-factor flow.
MultiFactorInfo
Represents a single second factor means for the user.
MultiFactorResolver
Utility class that contains methods to resolve second factor requirements on users that have opted into two-factor authentication.
MultiFactorSession
Identifies the current session to enroll a second factor or to complete sign in when previously enrolled.
MutableData
OAuthCredential
A generic OAuth credential.
OAuthProvider
A generic provider instance.
OnDisconnect
The Disconnect class encapsulates all operations to be performed on a Firebase when the client is disconnected. This allows you to write or clear data when your client disconnects from the Firebase servers. These updates occur whether your client disconnects cleanly or not, so you can rely on them to clean up data even if a connection is dropped or a client crashes.
PhoneAuthCredential
The auth credential returned from calling PhoneAuthProvider.credential.
PhoneAuthProvider
This class should be used to either create a new Phone credential with an verification ID and SMS code.
PhoneMultiFactorGenerator
Provider for generating a PhoneMultiFactorAssertion.
PhoneMultiFactorInfo
Represents the information for a phone second factor.
Query
A Query filters the data at a Firebase location so only a subset of the child data is visible to you. This can be used for example to restrict a large list of items down to a number suitable for synchronizing to the client.
RecaptchaVerifier
An reCAPTCHA-based application verifier.
Reference
SAMLAuthProvider
Security Assertion Markup Language based provider.
ServerValue
SettableMetadata
Task
A class representing an on-going storage task that additionally delegates to a Future.
TaskSnapshot
A TaskSnapshot is returned as the result or on-going process of a Task.
TransactionResult
The results of the transaction.
TwitterAuthCredential
An AuthCredential for authenticating via twitter.com
TwitterAuthProvider
This class should be used to either create a new Twitter credential with an access code, or use the provider to trigger user authentication flows.
UploadTask
A class which indicates an on-going upload task.
User
A user account.
UserCredential
A UserCredential is returned from authentication requests such as createUserWithEmailAndPassword.
UserInfo
Represents user data returned from an identity provider.
UserMetadata
Interface representing a user's metadata.

Enums

ActionCodeInfoOperation
The type of operation that generated the action code from calling checkActionCode.
Persistence
An enumeration of the possible persistence mechanism types.
PutStringFormat
The format in which a string can be uploaded to the storage bucket via Reference.putString.
RecaptchaVerifierSize
A enum to represent a reCAPTCHA widget size.
RecaptchaVerifierTheme
A enum to represent a reCAPTCHA widget theme.
TaskState
Represents the state of an on-going Task.

Typedefs

PhoneCodeAutoRetrievalTimeout = void Function(String verificationId)
Typedef for handling automatic phone number timeout resolution.
PhoneCodeSent = void Function(String verificationId, int? forceResendingToken)
Typedef for handling when Firebase sends a SMS code to the provided phone number.
PhoneVerificationCompleted = void Function(PhoneAuthCredential phoneAuthCredential)
Typedef for a automatic phone number resolution.
PhoneVerificationFailed = void Function(FirebaseAuthException error)
Typedef for handling errors via phone number verification.
RecaptchaVerifierOnError = void Function(FirebaseAuthException exception)
Called when the reCAPTCHA widget errors (such as a network error).
RecaptchaVerifierOnExpired = void Function()
Called when the time to complete the reCAPTCHA widget expires.
RecaptchaVerifierOnSuccess = void Function()
Called on successful completion of the reCAPTCHA widget.
TransactionHandler = FutureOr<MutableData?> Function(MutableData mutableData)

Exceptions / Errors

FirebaseAuthException
Generic exception related to Firebase Authentication.
FirebaseAuthMultiFactorException
MultiFactor exception related to Firebase Authentication. Check the error code and message for more details.
FirebaseDatabaseException
FirebaseException
A generic class which provides exceptions in a Firebase-friendly format to users.
StorageException