BaseIndexSettings class final

Annotations

• @JsonSerializable()

Constructors

BaseIndexSettings({List<String>? replicas, int? paginationLimitedTo, List<String>? unretrievableAttributes, List<String>? disableTypoToleranceOnWords, List<String>? attributesToTransliterate, List<String>? camelCaseAttributes, Object? decompoundedAttributes, List<String>? indexLanguages, List<String>? disablePrefixOnAttributes, bool? allowCompressionOfIntegerArray, List<String>? numericAttributesForFiltering, String? separatorsToIndex, List<String>? searchableAttributes, Object? userData, Map<String, Map<String, String>>? customNormalization, String? attributeForDistinct})

Returns a new BaseIndexSettings instance.

const

BaseIndexSettings.fromJson(Map<String, dynamic> json)

factory

Properties

allowCompressionOfIntegerArray → bool?

Incidates whether the engine compresses arrays with exclusively non-negative integers. When enabled, the compressed arrays may be reordered.

final

attributeForDistinct → String?

Name of the deduplication attribute to be used with Algolia's distinct feature.

final

attributesToTransliterate → List<String>?

Attributes in your index to which Japanese transliteration applies. This will ensure that words indexed in Katakana or Kanji can also be searched in Hiragana.

final

camelCaseAttributes → List<String>?

Attributes on which to split camel case words.

final

customNormalization → Map<String, Map<String, String>>?

A list of characters and their normalized replacements to override Algolia's default normalization.

final

decompoundedAttributes → Object?

Attributes in your index to which word segmentation (decompounding) applies.

final

disablePrefixOnAttributes → List<String>?

Attributes for which you want to turn off prefix matching.

final

disableTypoToleranceOnWords → List<String>?

Words for which you want to turn off typo tolerance.

final

hashCode → int

The hash code for this object.

no setter, override

indexLanguages → List<String>?

Set the languages of your index, for language-specific processing steps such as tokenization and normalization.

final

numericAttributesForFiltering → List<String>?

Numeric attributes that can be used as numerical filters.

final

paginationLimitedTo → int?

Maximum number of hits accessible through pagination.

final

replicas → List<String>?

Creates replicas, which are copies of a primary index with the same records but different settings.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

searchableAttributes → List<String>?

Attributes used for searching, including determining if matches at the beginning of a word are important (ordered) or not (unordered).

final

separatorsToIndex → String?

Controls which separators are added to an Algolia index as part of normalization. Separators are all non-letter characters except spaces and currency characters, such as $€£¥.

final

unretrievableAttributes → List<String>?

Attributes that can't be retrieved at query time.

final

userData → Object?

Lets you store custom data in your indices.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override