firebase library
Firebase is a global namespace from which all the Firebase services are accessed.
Classes
- ActionCodeEmail
- ActionCodeInfo
- A response from Auth.checkActionCode.
- ActionCodeSettings
- This is the 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.
- Analytics
- AnalyticsCallOptions
- AndroidSettings
- The Android settings.
- App
- A Firebase App holds the initialization information for a collection of services.
-
ApplicationVerifier<
T extends ApplicationVerifierJsImpl> - A verifier for domain verification and abuse prevention.
- Auth
- The Firebase Auth service class.
-
AuthProvider<
T extends AuthProviderJsImpl> - Represents an auth provider.
- ConfirmationResult
- A result from a phone number sign-in, link, or reauthenticate call.
- Database
- Firebase realtime database service class.
-
DatabaseReference<
T extends ReferenceJsImpl> - A DatabaseReference represents a specific location in database and can be used for reading or writing data to that database location.
- DataSnapshot
- A DataSnapshot contains data from a database location.
- EmailAuthProvider
- E-mail and password auth provider implementation.
- FacebookAuthProvider
- Facebook auth provider.
- FirebaseError
- FirebaseError is a subclass of the standard Error object. In addition to a message string, it contains a string-valued code.
- FirebaseOptions
- A structure for options provided to Firebase.
- FullMetadata
- The full set of object metadata, including read-only properties.
- Functions
- GithubAuthProvider
- Github auth provider.
- GoogleAuthProvider
- Google auth provider.
- HttpsCallable
- HttpsCallableOptions
- An HttpsCallableOptions is an option to set timeout property
- HttpsCallableResult
- IdTokenResult
- 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.
- IosSettings
- The iOS settings.
- ListOptions
- The options StorageReference.list accepts.
- ListResult
- Result returned by StorageReference.list.
- Messaging
- Notification
- OAuthCredential
- Interface that represents the OAuth credentials returned by an OAuth provider. Implementations specify the details about each auth provider's credential requirements.
- OAuthProvider
- OAuth auth provider.
- OnDisconnect
- The OnDisconnect class allows you to write or clear data when your client disconnects from the database server.
- Payload
- Performance
- Persistence
- An enumeration of the possible persistence mechanism types.
- PhoneAuthProvider
- Phone number auth provider.
-
Query<
T extends QueryJsImpl> - A Query sorts and filters the data at a database location so only a subset of the child data is included. This can be used to order a collection of data by some attribute as well as to restrict a large list of items down to a number suitable for synchronizing to the client.
- QueryEvent
- Event fired when data changes at location.
- RecaptchaVerifier
- reCAPTCHA verifier.
- RemoteConfig
- Provides access to Remote Config service.
- RemoteConfigSettings
- Defines configuration options for the Remote Config SDK.
- RemoteConfigValue
- Wraps a value with metadata and type-safe getters.
- ServerValue
- A placeholder value for auto-populating the current timestamp (time since the Unix epoch, in milliseconds) as determined by the Firebase servers.
- SettableMetadata
- Object metadata that can be set at any time.
- Storage
- A service for uploading and downloading large objects to and from the Google Cloud Storage.
- StorageReference
- StorageReference is a reference to a Google Cloud Storage object. It is possible to upload, download, and delete objects, as well as get or set the object metadata.
- StringFormat
- An enumeration of the possible string formats for upload.
- ThenableReference
- The ThenableReference class represents DatabaseReference with a Future property.
- Trace
- Transaction
- A structure used in DatabaseReference.transaction.
- TwitterAuthProvider
- Twitter auth provider.
- UploadMetadata
- Object metadata that can be set at upload.
- UploadTask
- Represents the process of uploading an object, and allows to monitor and manage the upload.
- UploadTaskSnapshot
- Holds data about the current state of the upload task.
- User
- User account.
- UserCredential
- A structure containing a User, an OAuthCredential and operationType. operationType could be 'signIn' for a sign-in operation, 'link' for a linking operation and 'reauthenticate' for a reauthentication operation.
-
UserInfo<
T extends UserInfoJsImpl> - User profile information, visible only to the Firebase project's apps.
- UserMetadata
- Interface representing a user's metadata.
- UserProfile
- A structure for User's user profile.
Enums
- RemoteConfigFetchStatus
- Summarizes the outcome of the last attempt to fetch config from the Firebase Remote Config server.
- RemoteConfigLogLevel
- Defines levels of Remote Config logging.
- RemoteConfigValueSource
- Indicates the source of a value.
- TaskState
- Represents the current state of a running upload.
Properties
-
apps
→ List<
App> -
A (read-only) array of all the initialized Apps.
no setter
- SDK_VERSION → String
-
The current SDK version.
no setter
Functions
-
analytics(
[App? app]) → Analytics - Accesses the Analytics service for the default App or a given app.
-
app(
[String? name]) → App - Retrieves an instance of an App.
-
auth(
[App? app]) → Auth - Gets the Auth object for the default App or a given App.
-
database(
[App? app]) → Database - Accesses the Database service for the default App or a given app.
-
enableLogging(
[dynamic logger, bool persistent = false]) → void -
Logs debugging information to the console.
If
persistent
, it remembers the logging state between page refreshes. -
firestore(
[App? app]) → Firestore - Accesses the Firestore service for the default App or a given app.
-
functions(
[App? app]) → Functions - Accesses the Functions service for the default App or a given app.
-
initializeApp(
{String? apiKey, String? authDomain, String? databaseURL, String? projectId, String? storageBucket, String? messagingSenderId, String? name, String? measurementId, String? appId}) → App - Creates (and initializes) a Firebase App with API key, auth domain, database URL and storage bucket.
-
messaging(
[App? app]) → Messaging - Accesses the Messaging service for the default App or a given app.
-
performance(
[App? app]) → Performance - Accesses the Performance service for the default App or a given app.
-
remoteConfig(
[App? app]) → RemoteConfig - Accesses the RemoteConfig service for the default App or a given app.
-
storage(
[App? app]) → Storage - The namespace for all the Storage functionality.
Exceptions / Errors
- FirebaseJsNotLoadedException
- Exception thrown when the firebase.js is not loaded.