AlgoliaQuery class
AlgoliaQuery
Represents a query over the data about search parameters.
- Implementers
Properties
- algolia → Algolia
-
final
- encodedIndex → String
-
no setter
- 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
-
custom(
String key, dynamic value) → AlgoliaQuery - Custom Parameter
-
deleteObjects(
) → Future< AlgoliaQuerySnapshot> - DeleteObjects
-
facetFilter(
dynamic value) → AlgoliaQuery - FacetFilters
-
filters(
String value) → AlgoliaQuery - Filters
-
getObjects(
) → Future< AlgoliaQuerySnapshot> - GetObjects
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
query(
String value) → AlgoliaQuery - Query
-
reference(
) → AlgoliaIndexReference - Obtains a AlgoliaIndex corresponding to this query's location.
-
search(
String value) → AlgoliaQuery - Search (query)
-
setAdvancedSyntax(
{bool enabled = false}) → AlgoliaQuery - AdvancedSyntax
-
setAllowCompressionOfIntegerArray(
{bool enabled = false}) → AlgoliaQuery - AllowCompressionOfIntegerArray
-
setAllowTyposOnNumericTokens(
bool value) → AlgoliaQuery - AllowTyposOnNumericTokens
-
setAnalytics(
{bool enabled = false}) → AlgoliaQuery - Analytics
-
setAnalyticsTags(
List< String> value) → AlgoliaQuery - AnalyticsTags
-
setAroundLatLng(
String value) → AlgoliaQuery - AroundLatLng
-
setAroundLatLngViaIP(
bool value) → AlgoliaQuery - AroundLatLngViaIP
-
setAroundPrecision(
int value) → AlgoliaQuery - AroundPrecision
-
setAroundRadius(
dynamic value) → AlgoliaQuery - AroundRadius
-
setAttributeCriteriaComputedByMinProximity(
{bool enabled = false}) → AlgoliaQuery - AttributeCriteriaComputedByMinProximity
-
setAttributeForDistinct(
String value) → AlgoliaQuery - attributeForDistinct
-
setAttributesForFaceting(
List< String> value) → AlgoliaQuery - AttributesForFaceting
-
setAttributesToHighlight(
List< String> value) → AlgoliaQuery - AttributesToHighlight
-
setAttributesToRetrieve(
List< String> value) → AlgoliaQuery - AttributesToRetrieve
-
setAttributesToSnippet(
List< String> value) → AlgoliaQuery - AttributesToSnippet
-
setCamelCaseAttributes(
List< String> value) → AlgoliaQuery - CamelCaseAttributes
-
setClickAnalytics(
{bool enabled = false}) → AlgoliaQuery - clickAnalytics
-
setDecompoundedAttributes(
dynamic value) → AlgoliaQuery - decompoundedAttributes
-
setDisableExactOnAttributes(
List< String> value) → AlgoliaQuery - DisableExactOnAttributes
-
setDisablePrefixOnAttributes(
List< String> value) → AlgoliaQuery - DisablePrefixOnAttributes
-
setDisableTypoToleranceOnAttributes(
List< String> value) → AlgoliaQuery - DisableTypoToleranceOnAttributes
-
setDisableTypoToleranceOnWords(
List< String> value) → AlgoliaQuery - DisableTypoToleranceOnWords
-
setDistinct(
{dynamic value = 0}) → AlgoliaQuery - distinct
-
setEnableABTest(
{bool enabled = false}) → AlgoliaQuery - EnableABTest
-
setEnablePersonalization(
{bool enabled = false}) → AlgoliaQuery - EnablePersonalization
-
setEnableRules(
{bool enabled = false}) → AlgoliaQuery - EnableRules
-
setExactOnSingleWordQuery(
ExactOnSingleWordQuery value) → AlgoliaQuery - ExactOnSingleWordQuery
-
setFacetFilter(
dynamic value) → AlgoliaQuery - FacetFilters
-
setFacetingAfterDistinct(
{bool enable = true}) → AlgoliaQuery - FacetingAfterDistinct
-
setFacets(
List< String> value) → AlgoliaQuery - Facets
-
setFilterPromotes(
{bool enabled = false}) → AlgoliaQuery - FilterPromotes
-
setFilters(
String value) → AlgoliaQuery - Filters
-
setGetRankingInfo(
{bool enabled = true}) → AlgoliaQuery - getRankingInfo
-
setHighlightPostTag(
String value) → AlgoliaQuery - HighlightPostTag
-
setHighlightPreTag(
String value) → AlgoliaQuery - HighlightPreTag
-
setHitsPerPage(
int value) → AlgoliaQuery - HitsPerPage
-
setIgnorePlurals(
dynamic value) → AlgoliaQuery - IgnorePlurals
-
setIndexLanguages(
List< String> value) → AlgoliaQuery - IndexLanguages
-
setInsideBoundingBox(
List< BoundingBox> value) → AlgoliaQuery - InsideBoundingBox
-
setInsidePolygon(
List< BoundingPolygonBox> value) → AlgoliaQuery - InsidePolygon
-
setkeepDiacriticsOnCharacters(
String value) → AlgoliaQuery - KeepDiacriticsOnCharacters
-
setLength(
int value) → AlgoliaQuery - Length
-
setMaxFacetHits(
int value) → AlgoliaQuery - MaxFacetHits
-
setMaxValuesPerFacet(
int value) → AlgoliaQuery - MaxValuesPerFacet
-
setMinimumAroundRadius(
int value) → AlgoliaQuery - MinimumAroundRadius
-
setMinWordSizeFor1Typo(
int value) → AlgoliaQuery - MinWordSizeFor1Typo
-
setMinWordSizeFor2Typos(
int value) → AlgoliaQuery - MinWordSizeFor2Typos
-
setNaturalLanguages(
List< String> value) → AlgoliaQuery - NaturalLanguages
-
setNumericAttributesForFiltering(
{required List< String> value}) → AlgoliaQuery - NumericAttributesForFiltering
-
setNumericFilter(
String value) → AlgoliaQuery - NumericFilters
-
setOffset(
int value) → AlgoliaQuery - Offset
-
setOptionalFilter(
String value) → AlgoliaQuery - OptionalFilters
-
setOptionalWords(
List< String> value) → AlgoliaQuery - optionalWords
-
setPage(
int value) → AlgoliaQuery - Page
-
setPaginationLimitedTo(
int value) → AlgoliaQuery - paginationLimitedTo
-
setPercentileComputation(
{bool enabled = false}) → AlgoliaQuery - PercentileComputation
-
setPersonalizationImpact(
{required int value}) → AlgoliaQuery - PersonalizationImpact
-
setQueryLanguages(
List< String> value) → AlgoliaQuery - QueryLanguages
-
setQueryType(
QueryType value) → AlgoliaQuery - QueryType
-
setRemoveStopWords(
dynamic value) → AlgoliaQuery - RemoveStopWords
-
setRemoveWordsIfNoResults(
RemoveWordsIfNoResults value) → AlgoliaQuery - RemoveWordsIfNoResults
-
setReplaceSynonymsInHighlight(
{bool enabled = false}) → AlgoliaQuery - ReplaceSynonymsInHighlight
-
setRestrictHighlightAndSnippetArrays(
{bool enable = true}) → AlgoliaQuery - RestrictHighlightAndSnippetArrays
-
setRestrictSearchableAttributes(
List< String> value) → AlgoliaQuery - RestrictSearchableAttributes
-
setRuleContexts(
List< String> value) → AlgoliaQuery - RuleContexts
-
setSearchableAttributes(
List< String> value) → AlgoliaQuery - SearchableAttributes
-
setSeparatorsToIndex(
String value) → AlgoliaQuery - SeparatorsToIndex
-
setSimilarQuery(
String value) → AlgoliaQuery - SimilarQuery)
-
setSnippetEllipsisText(
String value) → AlgoliaQuery - SnippetEllipsisText
-
setSortFacetValuesBy(
AlgoliaSortFacetValuesBy value) → AlgoliaQuery - SortFacetValuesBy
-
setSumOrFiltersScore(
bool value) → AlgoliaQuery - sumOrFiltersScores
-
setSynonyms(
{bool enabled = false}) → AlgoliaQuery - Synonyms
-
setTagFilter(
String value) → AlgoliaQuery - TagFilters
-
setTypoTolerance(
dynamic value) → AlgoliaQuery - TypoTolerance
-
setUnRetrievableAttributes(
List< String> value) → AlgoliaQuery - UnRetrievableAttributes
-
setUserToken(
String value) → AlgoliaQuery - UserToken
-
similarQuery(
String value) → AlgoliaQuery - SimilarQuery)
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited