AlgoliaQuery class

AlgoliaQuery

Represents a query over the data about search parameters.

Implementers

Properties

algolia Algolia
final
hashCode int
The hash code for this object.
no setterinherited
parameters Map<String, dynamic>
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

getObjects() Future<AlgoliaQuerySnapshot>
GetObjects
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reference() AlgoliaIndexReference
Obtains a AlgoliaIndex corresponding to this query's location.
Search (query)
setAllowTyposOnNumericTokens(bool value) AlgoliaQuery
AllowTyposOnNumericTokens
setAroundLatLng(String value) AlgoliaQuery
AroundLatLng
setAroundLatLngViaIP(bool value) AlgoliaQuery
AroundLatLngViaIP
setAroundPrecision(int value) AlgoliaQuery
AroundPrecision
setAroundRadius(dynamic value) AlgoliaQuery
AroundRadius
setAttributeForDistinct(String value) AlgoliaQuery
attributeForDistinct
setAttributesToHighlight(List<String> value) AlgoliaQuery
AttributesToHighlight
setAttributesToRetrieve(List<String> value) AlgoliaQuery
AttributesToRetrieve
setAttributesToSnippet(List<String> value) AlgoliaQuery
AttributesToSnippet
setClickAnalytics({bool enabled = false}) AlgoliaQuery
clickAnalytics
setDisableTypoToleranceOnAttributes(List<String> value) AlgoliaQuery
DisableTypoToleranceOnAttributes
setDistinct({dynamic value = 0}) AlgoliaQuery
distinct
setFacetFilter(dynamic value) AlgoliaQuery
FacetFilters
setFacetingAfterDistinct({bool enable = true}) AlgoliaQuery
FacetingAfterDistinct
setFacets(List<String> value) AlgoliaQuery
Facets
setFilters(String value) AlgoliaQuery
Filters
setGetRankingInfo({bool enabled = true}) AlgoliaQuery
getRankingInfo
setHighlightPostTag(String value) AlgoliaQuery
AttributesToSnippet
setHighlightPreTag(String value) AlgoliaQuery
AttributesToSnippet
setHitsPerPage(int value) AlgoliaQuery
HitsPerPage
setInsideBoundingBox(List<BoundingBox> value) AlgoliaQuery
InsideBoundingBox
setInsidePolygon(List<BoundingPolygonBox> value) AlgoliaQuery
InsidePolygon
setLength(int value) AlgoliaQuery
Length
setMaxValuesPerFacet(int value) AlgoliaQuery
MaxValuesPerFacet
setMinimumAroundRadius(int value) AlgoliaQuery
MinimumAroundRadius
setMinWordSizeFor1Typo(int value) AlgoliaQuery
MinWordSizeFor1Typo
setMinWordSizeFor2Typos(int value) AlgoliaQuery
MinWordSizeFor2Typos
setNumericFilter(String value) AlgoliaQuery
NumericFilters
setOffset(int value) AlgoliaQuery
Offset
setOptionalFilter(String value) AlgoliaQuery
OptionalFilters
setPage(int value) AlgoliaQuery
Page
setRestrictHighlightAndSnippetArrays({bool enable = true}) AlgoliaQuery
RestrictHighlightAndSnippetArrays
setRestrictSearchableAttributes(List<String> value) AlgoliaQuery
RestrictSearchableAttributes
setSnippetEllipsisText(String value) AlgoliaQuery
SnippetEllipsisText
setSortFacetValuesBy(AlgoliaSortFacetValuesBy value) AlgoliaQuery
SortFacetValuesBy
setSumOrFiltersScore(bool value) AlgoliaQuery
sumOrFiltersScores
setTagFilter(String value) AlgoliaQuery
TagFilters
setTypoTolerance(dynamic value) AlgoliaQuery
TypoTolerance
toString() String
A string representation of this object.
inherited

Operators

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