ModelAdapterCollectionQuery class
Query class to be passed when executing each function of ModelAdapter.
Use ModelAdapterDocumentQuery when executing functions for collections. Use ModelAdapterDocumentQuery to execute document queries.
ModelAdapterの各機能を実行する際に渡すクエリークラス。
コレクション用の機能を実行する際に利用します。ドキュメントのクエリを実行する際はModelAdapterDocumentQueryをご利用ください。
- Annotations
Constructors
-
ModelAdapterCollectionQuery({required CollectionModelQuery query, void callback(ModelUpdateNotification update)?, Object? origin, bool listen = true, int page = 1, Map<
String, String> headers = const {}, String? method}) -
Query class to be passed when executing each function of ModelAdapter.
const
Properties
- callback → void Function(ModelUpdateNotification update)?
-
A callback that is notified when there is a change in the corresponding collection.
final
- hashCode → int
-
The hash code for this object.
no setteroverride
-
headers
→ Map<
String, String> -
Headers for sending a request.
final
- listen → bool
-
Set to
true
to monitor query changes.final - method → String?
-
Method for sending a request.
final
- origin → Object?
-
The collection object from which to perform the query.
final
- page → int
-
Page number to be read. If ModelQueryFilterType.limit is set, additional reading is performed according to this page number.
final
- query → CollectionModelQuery
-
Collection queries.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
copyWith(
{Map< String, String> ? headers, String? method, int? page, CollectionModelQuery? query}) → ModelAdapterCollectionQuery -
Change
headers
ormethod
,page
, andquery
and copy. -
create<
T> ([String? id]) → ModelAdapterDocumentQuery -
Create a ModelAdapterDocumentQuery for a document under a collection using its own CollectionModelQuery and
id
. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override