AlgoliaSearchProvider<TModel, TFacets> class

Algolia query endpoint.

Algolia pages are zero-based while Dartvel's contract is one-based, so the page number is translated in both directions.

Inheritance

• Object
• DVHttpSearchProvider<TModel, TFacets>
• AlgoliaSearchProvider

Constructors

AlgoliaSearchProvider({required String applicationId, required String apiKey, required String indexName, required TModel fromJson(Map<String, Object?> hit), List<String> facetFields = const <String>[], DVSearchTuning tuning = const DVSearchTuning(), Uri? baseUrl, DVSearchFacetFilter<TFacets>? facetFilter, DVHttpSend transport = dvSendHttpRequest})

Properties

apiKey → String

final, inherited

applicationId → String

final

baseUrl → Uri

final, inherited

facetFields → List<String>

Attributes to return counts for.

final

facetFilter → DVSearchFacetFilter<TFacets>?

final, inherited

fromJson → TModel Function(Map<String, Object?> hit)

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

indexName → String

final, inherited

providerName → String

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transport → DVHttpSend

final, inherited

tuning → DVSearchTuning

Supplies the highlight markers; the engine does the matching.

final

Methods

buildRequest(String query, List<String> filters, int page, int perPage) → DVHttpRequest

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

query(String query, {TFacets? facets, int page = 1, int perPage = 20}) → Future<DVSearchResultPage<TModel>>

inherited

readHits(Map<String, Object?> payload, String key) → List<TModel>

inherited

readResponse(Map<String, Object?> payload, int page, int perPage) → DVSearchResultPage<TModel>

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited