FS class
The main class for Firestorm, providing access to Firestore and various operations.
Constructors
- FS()
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
- batch → FSBatchDelegate
-
final
- create → FSCreateDelegate
-
final
- delete → FSDeleteDelegate
-
final
-
deserializers
→ Map<
Type, Deserializer> -
final
- exists → FSExistDelegate
-
final
- get → FSGetDelegate
-
final
- instance ↔ FirebaseFirestore
-
getter/setter pair
- list → FSListDelegate
-
final
- listen → FSListenDelegate
-
final
- reference → FSReferenceDelegate
-
final
-
serializers
→ Map<
Type, Serializer> -
final
- transaction → FSTransactionDelegate
-
final
- update → FSUpdateDelegate
-
final
Static Methods
-
disableCaching(
) → dynamic - Disables local caching for Firestore data.
-
disableNetwork(
) → Future< void> - Disables network access for Firestore.
-
enableCaching(
) → dynamic - Enables local caching for Firestore data.
-
enableNetwork(
) → Future< void> - Enables network access for Firestore.
-
init(
) → dynamic - Initializes the Firestore instance. This should be called before any other Firestore operations.
-
initWithOptions(
FirebaseOptions options) → dynamic - Initializes the Firestore instance with custom options.
-
paginate<
T> ({String? lastDocumentID, int limit = 10, String? subcollection}) → FSPaginator< T> - Creates a paginator for Firestore queries.
-
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 Firestore instance. If used again, a new instance has to be created by calling FS.init()
-
useEmulator(
String host, int port) → dynamic - Configures Firestore to use the emulator instead of the real database.