ParseQuery<T extends ParseObject> class
The ParseQuery class defines a query that is used to fetch ParseObject. The most
common use case is finding all objects that match a query through the findAsync
method. For example, this sample code fetches all objects of class
MyClass
. It calls a different function depending on whether the fetch succeeded or not.
Constructors
- ParseQuery(String className)
- Constructs a query. A default query with no further parameters will retrieve all ParseObject of the provided class.
Properties
- className → String
-
The class name of ParseObject
final
-
includes
→ List<
String> -
read-only
- limit → int
-
read-only
-
order
→ List<
String> -
read-only
-
selectedKeys
→ List<
String> -
read-only
- skip → int
-
read-only
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
addAscendingOrder(
String key) → void - Also sorts the results in ascending order by the given key. [...]
-
addDescendingOrder(
String key) → void - Also sorts the results in descending order by the given key. [...]
-
countAsync(
) → Future< int> - Counts the number of objects that match this query in a background thread. This does not use caching.
-
findAsync(
) → Future< List< ParseObject> > - Retrieves a list of ParseObjects that satisfy this query from the source in a background thread.
-
include(
String key) → void - Include nested {@link ParseObject}s for the provided key. [...]
-
orderByAscending(
String key) → void - Sorts the results in ascending order by the given key.
-
orderByDescending(
String key) → void - Sorts the results in descending order by the given key.
-
selectKeys(
List< String> keys) → void - Restrict the fields of returned {@link ParseObject}s to only include the provided keys. [...]
-
setLimit(
int limit) → void - Controls the maximum number of results that are returned. [...]
-
setSkip(
int skip) → void - Controls the number of results to skip before returning any results. [...]
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
Returns a string representation of this object.
override
-
whereContainedIn(
String key, List values) → void - Add a constraint to the query that requires a particular key's value to be contained in the provided list of values.
-
whereContains(
String key, String substring) → void - Add a constraint for finding string values that contain a provided string. [...]
-
whereContainsAll(
String key, List values) → void - Add a constraint to the query that requires a particular key's value match another ParseQuery. [...]
-
whereDoesNotExist(
String key) → void - Add a constraint for finding objects that do not contain a given key.
-
whereDoesNotMatchKeyInQuery(
String key, String keyInQuery, ParseQuery< ParseObject> query) → void - Add a constraint to the query that requires a particular key's value does not match any value for a key in the results of another ParseQuery.
-
whereDoesNotMatchQuery(
String key, ParseQuery< ParseObject> query) → void - Add a constraint to the query that requires a particular key's value does not match another ParseQuery. [...]
-
whereEndsWith(
String key, String suffix) → void - Add a constraint for finding string values that end with a provided string. [...]
-
whereEqualTo(
String key, dynamic value) → void - Add a constraint to the query that requires a particular key's value to be equal to the provided value.
-
whereExists(
String key) → void - Add a constraint for finding objects that contain the given key.
-
whereFullText(
String key, String text) → void - Adds a constraint for finding string values that contain a provided string using Full Text Search
-
whereGreaterThan(
String key, dynamic value) → void - Add a constraint to the query that requires a particular key's value to be greater than the provided value.
-
whereGreaterThanOrEqualTo(
String key, dynamic value) → void - Add a constraint to the query that requires a particular key's value to be greater than or equal to the provided value.
-
whereLessThan(
String key, dynamic value) → void - Add a constraint to the query that requires a particular key's value to be less than the provided value.
-
whereLessThanOrEqualTo(
String key, dynamic value) → void - Add a constraint to the query that requires a particular key's value to be less than or equal to the provided value.
-
whereMatches(
String key, String regex, { String modifiers: '' }) → void - Add a regular expression constraint for finding string values that match the provided regular expression. [...]
-
whereMatchesKeyInQuery(
String key, String keyInQuery, ParseQuery< ParseObject> query) → void - Add a constraint to the query that requires a particular key's value matches a value for a key in the results of another ParseQuery.
-
whereMatchesQuery(
String key, ParseQuery< ParseObject> query) → void - Add a constraint to the query that requires a particular key's value match another ParseQuery. [...]
-
whereNear(
String key, ParseGeoPoint point) → void - Add a proximity based constraint for finding objects with key point values near the point given.
-
whereNotContainedIn(
String key, List values) → void - Add a constraint to the query that requires a particular key's value not be contained in the provided list of values.
-
whereNotEqualTo(
String key, dynamic value) → void - Add a constraint to the query that requires a particular key's value to be not equal to the provided value.
-
wherePolygonContains(
String key, ParseGeoPoint point) → void - Add a constraint to the query that requires a particular key's coordinates that contains a ParseGeoPoint [...]
-
whereStartsWith(
String key, String prefix) → void - Add a constraint for finding string values that start with a provided string. [...]
-
whereWithinGeoBox(
String key, ParseGeoPoint southwest, ParseGeoPoint northeast) → void - Add a constraint to the query that requires a particular key's coordinates be contained within a given rectangular geographic bounding box.
-
whereWithinKilometers(
String key, ParseGeoPoint point, double maxDistance) → void - Add a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given. [...]
-
whereWithinMiles(
String key, ParseGeoPoint point, double maxDistance) → void - Add a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given. [...]
-
whereWithinPolygon(
String key, List< ParseGeoPoint> points) → void - Adds a constraint to the query that requires a particular key's coordinates be contained within and on the bounds of a given polygon. Supports closed and open (last point is connected to first) paths [...]
-
whereWithinRadians(
String key, ParseGeoPoint point, double maxDistance) → void - Add a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
Operators
-
operator ==(
dynamic other) → bool -
The equality operator. [...]
inherited
Static Methods
-
or(
List< ParseQuery< queries) → ParseQuery<ParseObject> >ParseObject> -
Constructs a query that is the
or
of the given queries.