BrowseResponse class final
- Annotations
-
- @JsonSerializable()
Constructors
-
BrowseResponse({int? abTestID, int? abTestVariantID, String? aroundLatLng, String? automaticRadius, bool? exhaustiveFacetsCount, bool? exhaustiveNbHits, bool? exhaustiveTypo, Map<
String, Map< ? facets, Map<String, int> >String, FacetsStats> ? facetsStats, required int hitsPerPage, String? index, String? indexUsed, String? message, required int nbHits, required int nbPages, int? nbSortedHits, required int page, BaseSearchResponseRedirect? redirect, String? parsedQuery, required int processingTimeMS, String? queryAfterRemoval, String? serverUsed, Object? userData, RenderingContent? renderingContent, required List<Hit> hits, required String query, required String params, String? cursor}) -
Returns a new BrowseResponse instance.
const
-
BrowseResponse.fromJson(Map<
String, dynamic> json) -
factory
Properties
- abTestID → int?
-
A/B test ID. This is only included in the response for indices that are part of an A/B test.
final
- abTestVariantID → int?
-
Variant ID. This is only included in the response for indices that are part of an A/B test.
final
- aroundLatLng → String?
-
Computed geographical location.
final
- automaticRadius → String?
-
Automatically-computed radius.
final
- cursor → String?
-
Cursor indicating the location to resume browsing from. Must match the value returned by the previous call. Pass this value to the subsequent browse call to get the next page of results. When the end of the index has been reached,
cursoris absent from the response.final - exhaustiveFacetsCount → bool?
-
Indicates whether the facet count is exhaustive (exact) or approximate.
final
- exhaustiveNbHits → bool?
-
Indicates whether the number of hits
nbHitsis exhaustive (exact) or approximate.final - exhaustiveTypo → bool?
-
Indicates whether the search for typos was exhaustive (exact) or approximate.
final
-
facets
→ Map<
String, Map< ?String, int> > -
Mapping of each facet name to the corresponding facet counts.
final
-
facetsStats
→ Map<
String, FacetsStats> ? -
Statistics for numerical facets.
final
- hashCode → int
-
The hash code for this object.
no setteroverride
-
hits
→ List<
Hit> -
final
- hitsPerPage → int
-
Number of hits per page.
final
- index → String?
-
Index name used for the query.
final
- indexUsed → String?
-
Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.
final
- message → String?
-
Warnings about the query.
final
- nbHits → int
-
Number of hits the search query matched.
final
- nbPages → int
-
Number of pages of results for the current query.
final
- nbSortedHits → int?
-
Number of hits selected and sorted by the relevant sort algorithm.
final
- page → int
-
Page to retrieve (the first page is
0, not1).final - params → String
-
URL-encoded string of all search parameters.
final
- parsedQuery → String?
-
Post-normalization query string that will be searched.
final
- processingTimeMS → int
-
Time the server took to process the request, in milliseconds.
final
- query → String
-
Text to search for in an index.
final
- queryAfterRemoval → String?
-
Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
final
- redirect → BaseSearchResponseRedirect?
-
final
- renderingContent → RenderingContent?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serverUsed → String?
-
Host name of the server that processed the request.
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