AlgoliaIndexSettings class
AlgoliaIndexSettings
A AlgoliaIndexSettings object can be used to get setting instance, peform references, manage the index and querying for objects (using the methods inherited from AlgoliaSettings).
- Inheritance
-
- Object
- AlgoliaSettings
- AlgoliaIndexSettings
Properties
- algolia → Algolia
-
finalinherited
- encodedIndex → String
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
getSettings(
) → Future< Map< String, dynamic> > -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setAdvancedSyntax(
{bool enabled = false}) → AlgoliaSettings -
AdvancedSyntax
inherited
-
setAllowCompressionOfIntegerArray(
{bool enabled = false}) → AlgoliaSettings -
AllowCompressionOfIntegerArray
inherited
-
setAllowTyposOnNumericTokens(
bool value) → AlgoliaSettings -
AllowTyposOnNumericTokens
inherited
-
setAnalytics(
{bool enabled = false}) → AlgoliaSettings -
Analytics
inherited
-
setAnalyticsTags(
List< String> value) → AlgoliaSettings -
AnalyticsTags
inherited
-
setAroundLatLng(
String value) → AlgoliaSettings -
AroundLatLng
inherited
-
setAroundLatLngViaIP(
bool value) → AlgoliaSettings -
AroundLatLngViaIP
inherited
-
setAroundPrecision(
int value) → AlgoliaSettings -
AroundPrecision
inherited
-
setAroundRadius(
dynamic value) → AlgoliaSettings -
AroundRadius
inherited
-
setAttributeCriteriaComputedByMinProximity(
{bool enabled = false}) → AlgoliaSettings -
AttributeCriteriaComputedByMinProximity
inherited
-
setAttributeForDistinct(
String value) → AlgoliaSettings -
attributeForDistinct
inherited
-
setAttributesForFaceting(
List< String> value) → AlgoliaSettings -
AttributesForFaceting
inherited
-
setAttributesToHighlight(
List< String> value) → AlgoliaSettings -
AttributesToHighlight
inherited
-
setAttributesToRetrieve(
List< String> value) → AlgoliaSettings -
AttributesToRetrieve
inherited
-
setAttributesToSnippet(
List< String> value) → AlgoliaSettings -
AttributesToSnippet
inherited
-
setCamelCaseAttributes(
List< String> value) → AlgoliaSettings -
CamelCaseAttributes
inherited
-
setClickAnalytics(
{bool enabled = false}) → AlgoliaSettings -
clickAnalytics
inherited
-
setCustomRanking(
List< String> value) → AlgoliaSettings -
CustomRanking (Ranking)
inherited
-
setDecompoundedAttributes(
List< DecompoundedAttribute> value) → AlgoliaSettings -
decompoundedAttributes
inherited
-
setDisableExactOnAttributes(
List< String> value) → AlgoliaSettings -
DisableExactOnAttributes
inherited
-
setDisablePrefixOnAttributes(
List< String> value) → AlgoliaSettings -
DisablePrefixOnAttributes
inherited
-
setDisableTypoToleranceOnAttributes(
List< String> value) → AlgoliaSettings -
DisableTypoToleranceOnAttributes
inherited
-
setDisableTypoToleranceOnWords(
List< String> value) → AlgoliaSettings -
DisableTypoToleranceOnWords
inherited
-
setDistinct(
{dynamic value = 0}) → AlgoliaSettings -
distinct
inherited
-
setEnableABTest(
{bool enabled = false}) → AlgoliaSettings -
EnableABTest
inherited
-
setEnablePersonalization(
{bool enabled = false}) → AlgoliaSettings -
EnablePersonalization
inherited
-
setEnableRules(
{bool enabled = false}) → AlgoliaSettings -
EnableRules
inherited
-
setExactOnSingleWordQuery(
ExactOnSingleWordQuery value) → AlgoliaSettings -
ExactOnSingleWordQuery
inherited
-
setFacetFilter(
dynamic value) → AlgoliaSettings -
FacetFilters
inherited
-
setFacetingAfterDistinct(
{bool enable = true}) → AlgoliaSettings -
FacetingAfterDistinct
inherited
-
setFacets(
List< String> value) → AlgoliaSettings -
Facets
inherited
-
setFilterPromotes(
{bool enabled = false}) → AlgoliaSettings -
FilterPromotes
inherited
-
setFilters(
String value) → AlgoliaSettings -
Filters
inherited
-
setGetRankingInfo(
{bool enabled = true}) → AlgoliaSettings -
getRankingInfo
inherited
-
setHighlightPostTag(
String value) → AlgoliaSettings -
HighlightPostTag
inherited
-
setHighlightPreTag(
String value) → AlgoliaSettings -
HighlightPreTag
inherited
-
setHitsPerPage(
int value) → AlgoliaSettings -
HitsPerPage
inherited
-
setIgnorePlurals(
dynamic value) → AlgoliaSettings -
IgnorePlurals
inherited
-
setIndexLanguages(
List< String> value) → AlgoliaSettings -
IndexLanguages
inherited
-
setInsideBoundingBox(
List< BoundingBox> value) → AlgoliaSettings -
InsideBoundingBox
inherited
-
setInsidePolygon(
List< BoundingPolygonBox> value) → AlgoliaSettings -
InsidePolygon
inherited
-
setkeepDiacriticsOnCharacters(
String value) → AlgoliaSettings -
KeepDiacriticsOnCharacters
inherited
-
setLength(
int value) → AlgoliaSettings -
Length
inherited
-
setMaxFacetHits(
int value) → AlgoliaSettings -
MaxFacetHits
inherited
-
setMaxValuesPerFacet(
int value) → AlgoliaSettings -
MaxValuesPerFacet
inherited
-
setMinimumAroundRadius(
int value) → AlgoliaSettings -
MinimumAroundRadius
inherited
-
setMinWordSizeFor1Typo(
int value) → AlgoliaSettings -
MinWordSizeFor1Typo
inherited
-
setMinWordSizeFor2Typos(
int value) → AlgoliaSettings -
MinWordSizeFor2Typos
inherited
-
setNumericAttributesForFiltering(
List< String> value) → AlgoliaSettings -
NumericAttributesForFiltering
inherited
-
setNumericFilter(
String value) → AlgoliaSettings -
NumericFilters
inherited
-
setOffset(
int value) → AlgoliaSettings -
Offset
inherited
-
setOptionalFilter(
String value) → AlgoliaSettings -
OptionalFilters
inherited
-
setOptionalWords(
List< String> value) → AlgoliaSettings -
optionalWords
inherited
-
setPage(
int value) → AlgoliaSettings -
Page
inherited
-
setPaginationLimitedTo(
int value) → AlgoliaSettings -
paginationLimitedTo
inherited
-
setPercentileComputation(
{bool enabled = false}) → AlgoliaSettings -
PercentileComputation
inherited
-
setPersonalizationImpact(
{required int value}) → AlgoliaSettings -
PersonalizationImpact
inherited
-
setQueryLanguages(
List< String> value) → AlgoliaSettings -
QueryLanguages
inherited
-
setQueryType(
QueryType value) → AlgoliaSettings -
QueryType
inherited
-
setRanking(
List< String> value) → AlgoliaSettings -
Ranking (Ranking)
inherited
-
setRemoveStopWords(
dynamic value) → AlgoliaSettings -
RemoveStopWords
inherited
-
setRemoveWordsIfNoResults(
RemoveWordsIfNoResults value) → AlgoliaSettings -
RemoveWordsIfNoResults
inherited
-
setReplaceSynonymsInHighlight(
{bool enabled = false}) → AlgoliaSettings -
ReplaceSynonymsInHighlight
inherited
-
setReplicas(
List< String> value) → AlgoliaSettings -
Replicas (Ranking)
inherited
-
setRestrictHighlightAndSnippetArrays(
{bool enable = true}) → AlgoliaSettings -
RestrictHighlightAndSnippetArrays
inherited
-
setRestrictSearchableAttributes(
List< String> value) → AlgoliaSettings -
RestrictSearchableAttributes
inherited
-
setRuleContexts(
List< String> value) → AlgoliaSettings -
RuleContexts
inherited
-
setSearchableAttributes(
List< String> value) → AlgoliaSettings -
SearchableAttributes
inherited
-
setSeparatorsToIndex(
String value) → AlgoliaSettings -
SeparatorsToIndex
inherited
-
setSettings(
) → Future< AlgoliaTask> -
inherited
-
setSnippetEllipsisText(
String value) → AlgoliaSettings -
SnippetEllipsisText
inherited
-
setSortFacetValuesBy(
AlgoliaSortFacetValuesBy value) → AlgoliaSettings -
SortFacetValuesBy
inherited
-
setSumOrFiltersScore(
bool value) → AlgoliaSettings -
sumOrFiltersScores
inherited
-
setSynonyms(
{bool enabled = false}) → AlgoliaSettings -
Synonyms
inherited
-
setTagFilter(
String value) → AlgoliaSettings -
TagFilters
inherited
-
setTypoTolerance(
dynamic value) → AlgoliaSettings -
TypoTolerance
inherited
-
setUnRetrievableAttributes(
List< String> value) → AlgoliaSettings -
UnRetrievableAttributes
inherited
-
setUserToken(
{required String value}) → AlgoliaSettings -
UserToken
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited