FSPaginator<T> class
A paginator for Firestore queries that allows fetching objects in pages.
Constructors
- FSPaginator({String? lastDocumentID, int numOfDocuments = 10, String? subcollection})
- Creates a paginator for Firestore queries.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- lastDocumentID ↔ String?
-
getter/setter pair
- numOfDocuments ↔ int
-
getter/setter pair
-
query
↔ Query<
Object?> -
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- subcollection → String?
-
final
Methods
-
endAt(
List fieldValues) → FSPaginator< T> - Ends the query at a specific document where the field values provided are met.
-
endBefore(
List fieldValues) → FSPaginator< T> - Ends the query before a specific document where the field values provided are met.
-
limit(
int limit) → FSPaginator< T> - Limits the number of results.
-
next(
) → Future< FSQueryResult< T> > - Fetches the next page of objects.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
orderBy(
String field, {bool descending = false}) → FSPaginator< T> - Orders the query results by a field's value.
-
startAfter(
List fieldValues) → FSPaginator< T> - Starts the query after a specific document where the field values provided are met.
-
startAt(
List fieldValues) → FSPaginator< T> - Starts the query at a document where the field values provided are met.
-
stream(
) → Stream< T> - Streams the results of the query as a stream of type T.
-
toString(
) → String -
A string representation of this object.
inherited
-
whereArrayContains(
String field, dynamic value) → FSPaginator< T> - Filters results by array field containing a value.
-
whereArrayContainsAny(
String field, List values) → FSPaginator< T> - Filters results by array field containing a value.
-
whereEqualTo(
String field, dynamic value) → FSPaginator< T> - Filters results by equality.
-
whereGreaterThan(
String field, dynamic value) → FSPaginator< T> - Filters results by value (greater than).
-
whereGreaterThanOrEqualTo(
String field, dynamic value) → FSPaginator< T> - Filters results by value (greater than or equal to).
-
whereIn(
String field, List values) → FSPaginator< T> - Filters results by array field containing any of the provided values.
-
whereLessThan(
String field, dynamic value) → FSPaginator< T> - Filters results by value (less than).
-
whereLessThanOrEqualTo(
String field, dynamic value) → FSPaginator< T> - Filters results by value (less than or equal to).
-
whereNotEqualTo(
String field, dynamic value) → FSPaginator< T> - Filters results by inequality.
-
whereNotIn(
String field, List values) → FSPaginator< T> - Filters by an array field NOT containing any of the provided values.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited