SearchClient class final

Implemented types
Available Extensions

Constructors

SearchClient({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

customPost({required String path, Map<String, Object>? parameters, Object? body, RequestOptions? requestOptions}) Future<Object>
This method allow you to send requests to the Algolia REST API.
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>
Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
toString() String
A string representation of this object.
inherited

Operators

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