FireColl class

Firestore collection

Constructors

FireColl(CollectionReference<Map<String, dynamic>> reference)

Properties

hashCode int
The hash code for this object.
no setterinherited
query FireCollQuery
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

arrayFilter(String field, {Object? arrayContains, Iterable<Object?>? arrayContainsAny}) Future<List<FireDoc>>
filter(String field, dynamic value) Future<List<FireDoc>>
filter by field and value
filterWithStream(String field, dynamic value) Stream<List<FireDoc>>
filter by field and value as stream
getAllDocs<T>({T cast(Map<String, dynamic>)?}) Future<List<FireDocTuple<T>>>
get all documents in this collection
getAllDocsByStream<T>({T cast(Map<String, dynamic>)?}) Stream<List<FireDocTuple<T>>>
get all documents in this collection by stream
getAutoDoc([String? name]) FireDoc
get FireDoc by name if name is null, it will generate a random name.
getDeepColl(String name) FireColl
getDeepColl(name) == equal == getDoc(name).getColl(name);
getDoc(String name) FireDoc
Doc is a document in firestore Doc can include sub collections Doc can include fields and values
getListView({required Widget itemBuilder(BuildContext, FireDocTuple), void onRefresh(BuildContext)?, int pageSize = 10, FirestoreLoadingBuilder? loadingBuilder, FirestoreErrorBuilder? errorBuilder, FirestoreEmptyBuilder? emptyBuilder, Axis scrollDirection = Axis.vertical, bool reverse = false, ScrollController? controller, bool? primary, ScrollPhysics? physics, bool shrinkWrap = false, EdgeInsetsGeometry? padding, double? itemExtent, Widget? prototypeItem, bool addAutomaticKeepAlives = true, bool addRepaintBoundaries = true, bool addSemanticIndexes = true, double? cacheExtent, int? semanticChildCount, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip clipBehavior = Clip.hardEdge, (String, Object?)? equalWith, List<(String, Object?)>? filters, (String, bool)? orderBy}) Widget
To build a list view with pagination
getRandomNameDoc() FireDoc
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited
where(String field, {Object? isEqualTo, Object? isNotEqualTo, Object? isLessThan, Object? isLessThanOrEqualTo, Object? isGreaterThan, Object? isGreaterThanOrEqualTo, Object? arrayContains, Iterable<Object?>? arrayContainsAny, Iterable<Object?>? whereIn, Iterable<Object?>? whereNotIn, bool? isNull}) Future<List<FireDoc>>
be sure your user is signed when you call this, else it will throw an exception. you can use getUserDocSafe() instead, it will return null if user is not signed in.
whereWithStream(String field, {Object? isEqualTo, Object? isNotEqualTo, Object? isLessThan, Object? isLessThanOrEqualTo, Object? isGreaterThan, Object? isGreaterThanOrEqualTo, Object? arrayContains, Iterable<Object?>? arrayContainsAny, Iterable<Object?>? whereIn, Iterable<Object?>? whereNotIn, bool? isNull}) Stream<List<FireDoc>>

Operators

operator ==(Object other) bool
The equality operator.
inherited