AlgoliaIndexReference class
AlgoliaIndexReference
A AlgoliaIndexReference object can be used for adding object, getting object references, manage the index and querying for objects (using the methods inherited from AlgoliaQuery).
- Inheritance
-
- Object
- AlgoliaQuery
- AlgoliaIndexReference
Properties
- algolia → Algolia
-
finalinherited
- encodedIndex → String
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- index → String
-
ID of the referenced index.
no setter
-
parameters
→ Map<
String, dynamic> -
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- settings → AlgoliaIndexSettings
-
Settings
no setter
- synonyms → AlgoliaSynonymsReference
-
Synonyms
no setter
Methods
-
addObject(
Map< String, dynamic> data) → Future<AlgoliaTask> - AddObject
-
addObjects(
List< Map< objects) → Future<String, dynamic> >AlgoliaTask> - AddObjects
-
batch(
) → AlgoliaBatch - AlgoliaBatch
-
clearIndex(
) → Future< AlgoliaTask> - ClearIndex
-
copyIndex(
{required String destination, List< CopyScope> ? scopes}) → Future<AlgoliaTask> - CopyIndex
-
custom(
String key, dynamic value) → AlgoliaQuery -
Custom Parameter
inherited
-
deleteIndex(
) → Future< AlgoliaTask> - DeleteIndex
-
deleteObjects(
) → Future< AlgoliaQuerySnapshot> -
DeleteObjects
inherited
-
facetFilter(
dynamic value) → AlgoliaQuery -
FacetFilters
inherited
-
facetQuery(
String facetName, {String params = '', String facetQuery = '', int maxFacetHits = 10}) → Future< List< AlgoliaFacetValueSnapshot> > - FacetQuerys
-
filters(
String value) → AlgoliaQuery -
Filters
inherited
-
getObjects(
) → Future< AlgoliaQuerySnapshot> -
GetObjects
inherited
-
getObjectsByIds(
[List< String> objectIds = const []]) → Future<List< AlgoliaObjectSnapshot> > - GetObjects
-
moveIndex(
{required String destination}) → Future< AlgoliaTask> - MoveIndex
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
object(
[String? path]) → AlgoliaObjectReference -
query(
String value) → AlgoliaQuery -
Query
inherited
-
reference(
) → AlgoliaIndexReference -
Obtains a AlgoliaIndex corresponding to this query's location.
inherited
-
replaceAllObjects(
List< Map< objects) → Future<String, dynamic> >AlgoliaTask> - ReplaceAllObjects
-
search(
String value) → AlgoliaQuery -
Search (query)
inherited
-
setAdvancedSyntax(
{bool enabled = false}) → AlgoliaQuery -
AdvancedSyntax
inherited
-
setAllowCompressionOfIntegerArray(
{bool enabled = false}) → AlgoliaQuery -
AllowCompressionOfIntegerArray
inherited
-
setAllowTyposOnNumericTokens(
bool value) → AlgoliaQuery -
AllowTyposOnNumericTokens
inherited
-
setAnalytics(
{bool enabled = false}) → AlgoliaQuery -
Analytics
inherited
-
setAnalyticsTags(
List< String> value) → AlgoliaQuery -
AnalyticsTags
inherited
-
setAroundLatLng(
String value) → AlgoliaQuery -
AroundLatLng
inherited
-
setAroundLatLngViaIP(
bool value) → AlgoliaQuery -
AroundLatLngViaIP
inherited
-
setAroundPrecision(
int value) → AlgoliaQuery -
AroundPrecision
inherited
-
setAroundRadius(
dynamic value) → AlgoliaQuery -
AroundRadius
inherited
-
setAttributeCriteriaComputedByMinProximity(
{bool enabled = false}) → AlgoliaQuery -
AttributeCriteriaComputedByMinProximity
inherited
-
setAttributeForDistinct(
String value) → AlgoliaQuery -
attributeForDistinct
inherited
-
setAttributesForFaceting(
List< String> value) → AlgoliaQuery -
AttributesForFaceting
inherited
-
setAttributesToHighlight(
List< String> value) → AlgoliaQuery -
AttributesToHighlight
inherited
-
setAttributesToRetrieve(
List< String> value) → AlgoliaQuery -
AttributesToRetrieve
inherited
-
setAttributesToSnippet(
List< String> value) → AlgoliaQuery -
AttributesToSnippet
inherited
-
setCamelCaseAttributes(
List< String> value) → AlgoliaQuery -
CamelCaseAttributes
inherited
-
setClickAnalytics(
{bool enabled = false}) → AlgoliaQuery -
clickAnalytics
inherited
-
setDecompoundedAttributes(
dynamic value) → AlgoliaQuery -
decompoundedAttributes
inherited
-
setDisableExactOnAttributes(
List< String> value) → AlgoliaQuery -
DisableExactOnAttributes
inherited
-
setDisablePrefixOnAttributes(
List< String> value) → AlgoliaQuery -
DisablePrefixOnAttributes
inherited
-
setDisableTypoToleranceOnAttributes(
List< String> value) → AlgoliaQuery -
DisableTypoToleranceOnAttributes
inherited
-
setDisableTypoToleranceOnWords(
List< String> value) → AlgoliaQuery -
DisableTypoToleranceOnWords
inherited
-
setDistinct(
{dynamic value = 0}) → AlgoliaQuery -
distinct
inherited
-
setEnableABTest(
{bool enabled = false}) → AlgoliaQuery -
EnableABTest
inherited
-
setEnablePersonalization(
{bool enabled = false}) → AlgoliaQuery -
EnablePersonalization
inherited
-
setEnableRules(
{bool enabled = false}) → AlgoliaQuery -
EnableRules
inherited
-
setExactOnSingleWordQuery(
ExactOnSingleWordQuery value) → AlgoliaQuery -
ExactOnSingleWordQuery
inherited
-
setFacetFilter(
dynamic value) → AlgoliaQuery -
FacetFilters
inherited
-
setFacetingAfterDistinct(
{bool enable = true}) → AlgoliaQuery -
FacetingAfterDistinct
inherited
-
setFacets(
List< String> value) → AlgoliaQuery -
Facets
inherited
-
setFilterPromotes(
{bool enabled = false}) → AlgoliaQuery -
FilterPromotes
inherited
-
setFilters(
String value) → AlgoliaQuery -
Filters
inherited
-
setGetRankingInfo(
{bool enabled = true}) → AlgoliaQuery -
getRankingInfo
inherited
-
setHighlightPostTag(
String value) → AlgoliaQuery -
HighlightPostTag
inherited
-
setHighlightPreTag(
String value) → AlgoliaQuery -
HighlightPreTag
inherited
-
setHitsPerPage(
int value) → AlgoliaQuery -
HitsPerPage
inherited
-
setIgnorePlurals(
dynamic value) → AlgoliaQuery -
IgnorePlurals
inherited
-
setIndexLanguages(
List< String> value) → AlgoliaQuery -
IndexLanguages
inherited
-
setInsideBoundingBox(
List< BoundingBox> value) → AlgoliaQuery -
InsideBoundingBox
inherited
-
setInsidePolygon(
List< BoundingPolygonBox> value) → AlgoliaQuery -
InsidePolygon
inherited
-
setkeepDiacriticsOnCharacters(
String value) → AlgoliaQuery -
KeepDiacriticsOnCharacters
inherited
-
setLength(
int value) → AlgoliaQuery -
Length
inherited
-
setMaxFacetHits(
int value) → AlgoliaQuery -
MaxFacetHits
inherited
-
setMaxValuesPerFacet(
int value) → AlgoliaQuery -
MaxValuesPerFacet
inherited
-
setMinimumAroundRadius(
int value) → AlgoliaQuery -
MinimumAroundRadius
inherited
-
setMinWordSizeFor1Typo(
int value) → AlgoliaQuery -
MinWordSizeFor1Typo
inherited
-
setMinWordSizeFor2Typos(
int value) → AlgoliaQuery -
MinWordSizeFor2Typos
inherited
-
setNaturalLanguages(
List< String> value) → AlgoliaQuery -
NaturalLanguages
inherited
-
setNumericAttributesForFiltering(
{required List< String> value}) → AlgoliaQuery -
NumericAttributesForFiltering
inherited
-
setNumericFilter(
String value) → AlgoliaQuery -
NumericFilters
inherited
-
setOffset(
int value) → AlgoliaQuery -
Offset
inherited
-
setOptionalFilter(
String value) → AlgoliaQuery -
OptionalFilters
inherited
-
setOptionalWords(
List< String> value) → AlgoliaQuery -
optionalWords
inherited
-
setPage(
int value) → AlgoliaQuery -
Page
inherited
-
setPaginationLimitedTo(
int value) → AlgoliaQuery -
paginationLimitedTo
inherited
-
setPercentileComputation(
{bool enabled = false}) → AlgoliaQuery -
PercentileComputation
inherited
-
setPersonalizationImpact(
{required int value}) → AlgoliaQuery -
PersonalizationImpact
inherited
-
setQueryLanguages(
List< String> value) → AlgoliaQuery -
QueryLanguages
inherited
-
setQueryType(
QueryType value) → AlgoliaQuery -
QueryType
inherited
-
setRemoveStopWords(
dynamic value) → AlgoliaQuery -
RemoveStopWords
inherited
-
setRemoveWordsIfNoResults(
RemoveWordsIfNoResults value) → AlgoliaQuery -
RemoveWordsIfNoResults
inherited
-
setReplaceSynonymsInHighlight(
{bool enabled = false}) → AlgoliaQuery -
ReplaceSynonymsInHighlight
inherited
-
setRestrictHighlightAndSnippetArrays(
{bool enable = true}) → AlgoliaQuery -
RestrictHighlightAndSnippetArrays
inherited
-
setRestrictSearchableAttributes(
List< String> value) → AlgoliaQuery -
RestrictSearchableAttributes
inherited
-
setRuleContexts(
List< String> value) → AlgoliaQuery -
RuleContexts
inherited
-
setSearchableAttributes(
List< String> value) → AlgoliaQuery -
SearchableAttributes
inherited
-
setSeparatorsToIndex(
String value) → AlgoliaQuery -
SeparatorsToIndex
inherited
-
setSimilarQuery(
String value) → AlgoliaQuery -
SimilarQuery)
inherited
-
setSnippetEllipsisText(
String value) → AlgoliaQuery -
SnippetEllipsisText
inherited
-
setSortFacetValuesBy(
AlgoliaSortFacetValuesBy value) → AlgoliaQuery -
SortFacetValuesBy
inherited
-
setSumOrFiltersScore(
bool value) → AlgoliaQuery -
sumOrFiltersScores
inherited
-
setSynonyms(
{bool enabled = false}) → AlgoliaQuery -
Synonyms
inherited
-
setTagFilter(
String value) → AlgoliaQuery -
TagFilters
inherited
-
setTypoTolerance(
dynamic value) → AlgoliaQuery -
TypoTolerance
inherited
-
setUnRetrievableAttributes(
List< String> value) → AlgoliaQuery -
UnRetrievableAttributes
inherited
-
setUserToken(
String value) → AlgoliaQuery -
UserToken
inherited
-
similarQuery(
String value) → AlgoliaQuery -
SimilarQuery)
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited