CatalogQuery class

Annotations
  • @JsonSerializable()

Constructors

CatalogQuery({CatalogQuerySortedAttribute? sortedAttributeQuery, CatalogQueryExact? exactQuery, CatalogQuerySet? setQuery, CatalogQueryPrefix? prefixQuery, CatalogQueryRange? rangeQuery, CatalogQueryText? textQuery, CatalogQueryItemsForTax? itemsForTaxQuery, CatalogQueryItemsForModifierList? itemsForModifierListQuery, CatalogQueryItemVariationsForItemOptionValues? itemVariationsForItemOptionValuesQuery, CatalogQueryItemsForItemOptions? itemsForItemOptionsQuery})
const
CatalogQuery.fromJson(Map<String, dynamic> json)
Converts a Map to an CatalogQuery
factory

Properties

exactQuery → CatalogQueryExact?
An exact query expression to return objects with attribute name and value matching the specified attribute name and value exactly. Value matching is case insensitive.
final
hashCode → int
The hash code for this object.
no setterinherited
itemsForItemOptionsQuery → CatalogQueryItemsForItemOptions?
A query expression to return items that contains the specified item options (as identified the corresponding CatalogItemOption IDs).
final
itemsForModifierListQuery → CatalogQueryItemsForModifierList?
A query expression to return items that have any of the given modifier list (as identified by the corresponding CatalogModifierLists IDs) enabled.
final
itemsForTaxQuery → CatalogQueryItemsForTax?
A query expression to return items that have any of the specified taxes (as identified by the corresponding CatalogTax object IDs) enabled.
final
itemVariationsForItemOptionValuesQuery → CatalogQueryItemVariationsForItemOptionValues?
A query expression to return item variations (of the CatalogItemVariation type) that contain all of the specified CatalogItemOption IDs.
final
prefixQuery → CatalogQueryPrefix?
A prefix query expression to return objects with attribute values that have a prefix matching the specified string value. Value matching is case insensitive.
final
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setter
rangeQuery → CatalogQueryRange?
A range query expression to return objects with numeric values that lie in the specified range.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
setQuery → CatalogQuerySet?
A set query expression to return objects with attribute name and value matching the specified attribute name and any of the specified attribute values exactly. Value matching is case insensitive.
final
sortedAttributeQuery → CatalogQuerySortedAttribute?
A query expression to sort returned query result by the given attribute.
final
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
textQuery → CatalogQueryText?
A text query expression to return objects whose searchable attributes contain all of the given keywords, irrespective of their order. For example, if a CatalogItem contains custom attribute values of {"name": "t-shirt"} and {"description": "Small, Purple"}, the query filter of {"keywords": "shirt", "sma", "purp"} returns this item.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts a CatalogQuery to a Map
toString() → String
A string representation of this object.
inherited

Operators

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