SearchClient class final

Implemented types
Available extensions

Constructors

SearchClient.new({required String appId, required String apiKey, ClientOptions options = const ClientOptions()})

Properties

apiKey → String
The API key used for authentication.
final
appId → String
The unique identifier for the application using the API client.
final
hashCode → int
The hash code for this object.
no setterinherited
options → ClientOptions
A set of custom client options to configure the behavior of the API client.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

dispose() → void
Dispose of underlying resources.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
post({required String path, Map<String, Object>? parameters, Object? body, RequestOptions? requestOptions}) → Future<Object>
Send requests to the Algolia REST API. This method allow you to send requests to the Algolia REST API.
Search multiple indices. Send multiple search queries to one or more indices.
searchForFacets({required List<SearchForFacets> requests, SearchStrategy? strategy, RequestOptions? requestOptions}) → Future<Iterable<SearchForFacetValuesResponse>>

Available on SearchClient, provided by the SearchClientExt extension

Calls the search method but with certainty that we will only request Algolia facets.
searchForHits({required List<SearchForHits> requests, SearchStrategy? strategy, RequestOptions? requestOptions}) → Future<Iterable<SearchResponse>>

Available on SearchClient, provided by the SearchClientExt extension

Calls the search method but with certainty that we will only request Algolia records (hits).
searchIndex({required SearchForHits request, RequestOptions? requestOptions}) → Future<SearchResponse>

Available on SearchClient, provided by the SearchClientExt extension

Perform a search operation targeting one index.
searchMultiIndex({required List<SearchForHits> queries, SearchStrategy? strategy, RequestOptions? requestOptions}) → Future<Iterable<SearchResponse>>

Available on SearchClient, provided by the SearchClientExt extension

Perform a search operation targeting one index.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited