IndexHits class

Constructors

IndexHits({int? estimatedTotalHits, List<Object> hits = const [], int? limit, int? offset, int? processingTimeMs, String? query})

Returns a new IndexHits instance.

Properties

estimatedTotalHits ↔ int?

EstimatedTotalHits is the dialect's name for the match count. Every hit is materialised here, so for this page it is exact rather than estimated.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

hits ↔ List<Object>

Hits are the matching documents, most relevant first, exactly as stored.

getter/setter pair

limit ↔ int?

Limit is how many hits this page could hold.

getter/setter pair

offset ↔ int?

Offset is where this page starts.

getter/setter pair

processingTimeMs ↔ int?

ProcessingTimeMs is how long the query took, in milliseconds.

getter/setter pair

query ↔ String?

Query echoes the search terms, which is what a client renders above the results.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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

Static Methods

fromJson(dynamic value) → IndexHits?

Returns a new IndexHits instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<IndexHits>

mapFromJson(dynamic json) → Map<String, IndexHits>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<IndexHits>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.