RecommendClient class final

Implemented types

Constructors

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

del({required String path, Map<String, Object>? parameters, RequestOptions? requestOptions}) → Future<Object>
Send requests to the Algolia REST API. This method allow you to send requests to the Algolia REST API.
deleteRecommendRule({required String indexName, required RecommendModels model, required String objectID, RequestOptions? requestOptions}) → Future<DeletedAtResponse>
Delete a Recommend rule. Delete a Recommend rule.
dispose() → void
Dispose of underlying resources.
override
get({required String path, Map<String, Object>? parameters, RequestOptions? requestOptions}) → Future<Object>
Send requests to the Algolia REST API. This method allow you to send requests to the Algolia REST API.
getRecommendations({required GetRecommendationsParams getRecommendationsParams, RequestOptions? requestOptions}) → Future<GetRecommendationsResponse>
Get recommendations and trending items. Returns results from either recommendation or trending models: - Recommendations are provided by the Related Products and Frequently Bought Together models - Trending models are Trending Items and Trending Facet Values.
getRecommendRule({required String indexName, required RecommendModels model, required String objectID, RequestOptions? requestOptions}) → Future<RuleResponse>
Get a Recommend rule. Return a Recommend rule.
getRecommendStatus({required String indexName, required RecommendModels model, required int taskID, RequestOptions? requestOptions}) → Future<GetRecommendTaskResponse>
Get a Recommend task's status. Some operations, such as deleting a Recommend rule, will respond with a taskID value. Use this value here to check the status of that task.
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.
put({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.
searchRecommendRules({required String indexName, required RecommendModels model, SearchRecommendRulesParams? searchRecommendRulesParams, RequestOptions? requestOptions}) → Future<SearchRecommendRulesResponse>
List Recommend rules. List Recommend rules.
toString() → String
A string representation of this object.
inherited

Operators

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