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
- 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
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
-
deleteIndex(
) → Future< AlgoliaTask> - DeleteIndex
-
getObjects(
) → Future< AlgoliaQuerySnapshot> -
GetObjects
inherited
-
getObjectsByIds(
[List< String> ? objectIds]) → 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 -
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
-
setAllowTyposOnNumericTokens(
bool value) → AlgoliaQuery -
AllowTyposOnNumericTokens
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
-
setAttributeForDistinct(
String value) → AlgoliaQuery -
attributeForDistinct
inherited
-
setAttributesToHighlight(
List< String> value) → AlgoliaQuery -
AttributesToHighlight
inherited
-
setAttributesToRetrieve(
List< String> value) → AlgoliaQuery -
AttributesToRetrieve
inherited
-
setAttributesToSnippet(
List< String> value) → AlgoliaQuery -
AttributesToSnippet
inherited
-
setClickAnalytics(
{bool enabled = false}) → AlgoliaQuery -
clickAnalytics
inherited
-
setDisableTypoToleranceOnAttributes(
List< String> value) → AlgoliaQuery -
DisableTypoToleranceOnAttributes
inherited
-
setDistinct(
{dynamic value = 0}) → AlgoliaQuery -
distinct
inherited
-
setFacetFilter(
dynamic value) → AlgoliaQuery -
FacetFilters
inherited
-
setFacetingAfterDistinct(
{bool enable = true}) → AlgoliaQuery -
FacetingAfterDistinct
inherited
-
setFacets(
List< String> value) → AlgoliaQuery -
Facets
inherited
-
setFilters(
String value) → AlgoliaQuery -
Filters
inherited
-
setGetRankingInfo(
{bool enabled = true}) → AlgoliaQuery -
getRankingInfo
inherited
-
setHighlightPostTag(
String value) → AlgoliaQuery -
AttributesToSnippet
inherited
-
setHighlightPreTag(
String value) → AlgoliaQuery -
AttributesToSnippet
inherited
-
setHitsPerPage(
int value) → AlgoliaQuery -
HitsPerPage
inherited
-
setInsideBoundingBox(
List< BoundingBox> value) → AlgoliaQuery -
InsideBoundingBox
inherited
-
setInsidePolygon(
List< BoundingPolygonBox> value) → AlgoliaQuery -
InsidePolygon
inherited
-
setLength(
int value) → AlgoliaQuery -
Length
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
-
setNumericFilter(
String value) → AlgoliaQuery -
NumericFilters
inherited
-
setOffset(
int value) → AlgoliaQuery -
Offset
inherited
-
setOptionalFilter(
String value) → AlgoliaQuery -
OptionalFilters
inherited
-
setPage(
int value) → AlgoliaQuery -
Page
inherited
-
setRestrictHighlightAndSnippetArrays(
{bool enable = true}) → AlgoliaQuery -
RestrictHighlightAndSnippetArrays
inherited
-
setRestrictSearchableAttributes(
List< String> value) → AlgoliaQuery -
RestrictSearchableAttributes
inherited
-
setSnippetEllipsisText(
String value) → AlgoliaQuery -
SnippetEllipsisText
inherited
-
setSortFacetValuesBy(
AlgoliaSortFacetValuesBy value) → AlgoliaQuery -
SortFacetValuesBy
inherited
-
setSumOrFiltersScore(
bool value) → AlgoliaQuery -
sumOrFiltersScores
inherited
-
setTagFilter(
String value) → AlgoliaQuery -
TagFilters
inherited
-
setTypoTolerance(
dynamic value) → AlgoliaQuery -
TypoTolerance
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited