RDB class
The main class for Firestorm, providing access to Firestore and various operations.
Constructors
- RDB()
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
-
classNames
→ Map<
Type, String> -
final
- create → RDBCreateDelegate
-
final
- delete → RDBDeleteDelegate
-
final
-
deserializers
→ Map<
Type, Deserializer> -
final
- exists → RDBExistDelegate
-
final
- get → RDBGetDelegate
-
final
- instance ↔ FirebaseDatabase
-
getter/setter pair
- list → RDBListDelegate
-
final
- listen → RDBListenDelegate
-
final
- reference → RDBReferenceDelegate
-
final
-
serializers
→ Map<
Type, Serializer> -
final
- update → RDBUpdateDelegate
-
final
Static Methods
-
constructPathForClass(
String typeName, {String? subcollection}) → String - Constructs a path for a class.
-
constructPathForClassAndID(
String typeName, String id, {String? subcollection}) → String - Constructs a path for a RDB object based on its type and ID.
-
disableCaching(
) → Future< void> - Disables local caching for Firestore data.
-
enableCaching(
) → Future< void> - Enables local caching for Firestore data.
-
init(
) → Future< void> - Initializes the RDB instance. This should be called before any other Firestore operations.
-
initWithOptions(
FirebaseOptions options) → Future< void> - Initializes the RDB instance with custom options.
-
registerClassName(
Type type, String typeName) → void - Registers a type name for release config compatibility (avoiding code obfuscation issues):
-
registerDeserializer<
T> (T fromMap(Map< String, dynamic> )) → void - Registers a deserializer for a specific type. Needed for dynamically deserializing objects. NOTE: This function is called by generated code in the target Flutter app. You should not call this function directly in your code.
-
registerSerializer<
T> (Map< String, dynamic> function(T obj)) → void - Registers a serializer for a specific type. Needed for dynamically serializing objects. NOTE: This function is called by generated code in the target Flutter app. You should not call this function directly in your code.
-
shutdown(
) → Future< void> - Shuts down the RDB instance. If used again, a new instance has to be created by calling RDB.init().
-
useEmulator(
String host, int port) → void - Configures RDB to use the emulator instead of the real database.