firebase_database_rest library

Classes

ApiConstants
Various constants, relevant for the Realtime database API
AutoRenewStream<T>
A wrapper around streams that throw AuthRevokedExceptions to automatically reconnect and continue the stream seamlessly.
ETagReceiver
A helper class to obtain ETags from FirebaseStore requests.
Filter
A helper class to dynamically construct realtime database queries.
FilterBuilder<T>
A helper class to build filter queries.
FirebaseDatabase
The root database that manages access to the firebase realtime database.
FirebaseStore<T>
A store the provides access to a selected part of a firebase database.
FirebaseTimestamp
A virtual timestamp that can either be a DateTime or a server set value.
FirebaseTransaction<T>
An interface for transactions on the realtime database
JsonConverter<T>
A small interface for classes that can be used as a json converter for T
KeyEvent
An event produced by streams of FirebaseStore to watch changes on the store keys.
PatchSet<T>
An interface for patchsets that can be applied to an instance of T
SingleCommitTransaction<T>
A helper class to easily create single commit transaction.
StoreEvent<T>
An event produced by streams of FirebaseStore to watch changes on the store.
StoreEventTransformer<T>
A stream transformer that converts a stream of StreamEvents into a stream of StoreEvents, deserializing the received data and turing database status updates into data updates.
StoreKeyEventTransformer
A stream transformer that converts a stream of StreamEvents into a stream of KeyEvents, deserializing the received data and turing database status updates into key updates.
StoreValueEventTransformer<T>
A stream transformer that converts a stream of StreamEvents into a stream of ValueEvents, deserializing the received data and turing database status updates into data updates.
Timeout
Specifies timeout for read requests.
ValueEvent<T>
An event produced by streams of FirebaseStore to watch changes on the specific store entry.

Enums

FormatMode
Specifies how the server should format the reponse
PrintMode
Formats the data returned in the response from the server.
WriteSizeLimit
Realtime Database estimates the size of each write request and aborts requests that will take longer than the target time.

Extensions

FormatModeX on FormatMode
Extension on FormatMode to get the server expected string
PrintModeX on PrintMode
Extension on PrintMode to get the server expected string
WriteSizeLimitX on WriteSizeLimit
Extension on WriteSizeLimit to get the server expected string

Typedefs

DataFromJsonCallback<T> = T Function(dynamic json)
A callback definition for a method that converts a json object to a data type.
DataToJsonCallback<T> = dynamic Function(T data)
A callback definition for a method that converts a data type to a json object.
PatchDataCallback<T> = T Function(T data, Map<String, dynamic> updatedFields)
A callback definition for a method that applies a set of updatedFields on existing data.
PatchSetFactory<T> = PatchSet<T> Function(Map<String, dynamic> updatedFields)
A callback the generates instances of a PatchSet from a set of updatedFields.
StreamFactory<T> = Future<Stream<T>> Function()
Method signature of a stream factory method.

Exceptions / Errors

AlreadyComittedError
Error that gets thrown if a SingleCommitTransaction has already been committed.
AuthRevokedException
An exception that is thrown by FirebaseStore streams when the current authentication must be refreshed.
DbException
A generic exception representing an error when accessing the realtime database
TransactionFailedException
Exception that gets thrown if the server rejects the transaction because the eTag has been modified.