Package com.algolia.search

Class UserInsightsClient

java.lang.Object

com.algolia.search.UserInsightsClient

public final class UserInsightsClient
extends Object

Constructor Summary

Constructors

Constructor	Description
UserInsightsClient(String userToken, InsightsClient insightsClient)

Method Summary

Modifier and Type	Method	Description
InsightsResult	clickedFilters(String eventName, String indexName, List<String> filters)
InsightsResult	clickedFilters(String eventName, String indexName, List<String> filters, RequestOptions requestOptions)
CompletableFuture<InsightsResult>	clickedFiltersAsync(String eventName, String indexName, List<String> filters)
CompletableFuture<InsightsResult>	clickedFiltersAsync(String eventName, String indexName, List<String> filters, RequestOptions requestOptions)
InsightsResult	clickedObjectIDs(String eventName, String indexName, List<String> objectIDs)
InsightsResult	clickedObjectIDs(String eventName, String indexName, List<String> objectIDs, RequestOptions requestOptions)
InsightsResult	clickedObjectIDsAfterSearch(String eventName, String indexName, List<String> objectIDs, List<Long> positions, String queryID)
InsightsResult	clickedObjectIDsAfterSearch(String eventName, String indexName, List<String> objectIDs, List<Long> positions, String queryID, RequestOptions requestOptions)
CompletableFuture<InsightsResult>	clickedObjectIDsAfterSearchAsync(String eventName, String indexName, List<String> objectIDs, List<Long> positions, String queryID)
CompletableFuture<InsightsResult>	clickedObjectIDsAfterSearchAsync(String eventName, String indexName, List<String> objectIDs, List<Long> positions, String queryID, RequestOptions requestOptions)
CompletableFuture<InsightsResult>	clickedObjectIDsAsync(String eventName, String indexName, List<String> objectIDs)
CompletableFuture<InsightsResult>	clickedObjectIDsAsync(String eventName, String indexName, List<String> objectIDs, RequestOptions requestOptions)
InsightsResult	convertedFilters(String eventName, String indexName, List<String> filters)
InsightsResult	convertedFilters(String eventName, String indexName, List<String> filters, RequestOptions requestOptions)
CompletableFuture<InsightsResult>	convertedFiltersAsync(String eventName, String indexName, List<String> filters)
CompletableFuture<InsightsResult>	convertedFiltersAsync(String eventName, String indexName, List<String> filters, RequestOptions requestOptions)
InsightsResult	convertedObjectIDs(String eventName, String indexName, List<String> objectIDs)
InsightsResult	convertedObjectIDs(String eventName, String indexName, List<String> objectIDs, RequestOptions requestOptions)
InsightsResult	convertedObjectIDsAfterSearch(String eventName, String indexName, List<String> objectIDs, String queryID)
InsightsResult	convertedObjectIDsAfterSearch(String eventName, String indexName, List<String> objectIDs, String queryID, RequestOptions requestOptions)
CompletableFuture<InsightsResult>	convertedObjectIDsAfterSearchAsync(String eventName, String indexName, List<String> objectIDs, String queryID)
CompletableFuture<InsightsResult>	convertedObjectIDsAfterSearchAsync(String eventName, String indexName, List<String> objectIDs, String queryID, RequestOptions requestOptions)
CompletableFuture<InsightsResult>	convertedObjectIDsAsync(String eventName, String indexName, List<String> objectIDs)
CompletableFuture<InsightsResult>	convertedObjectIDsAsync(String eventName, String indexName, List<String> objectIDs, RequestOptions requestOptions)
InsightsResult	viewedFilters(String eventName, String indexName, List<String> filters)
InsightsResult	viewedFilters(String eventName, String indexName, List<String> filters, RequestOptions requestOptions)
CompletableFuture<InsightsResult>	viewedFiltersAsync(String eventName, String indexName, List<String> filters)
CompletableFuture<InsightsResult>	viewedFiltersAsync(String eventName, String indexName, List<String> filters, RequestOptions requestOptions)
InsightsResult	viewedObjectIDs(String eventName, String indexName, List<String> objectIDs)
InsightsResult	viewedObjectIDs(String eventName, String indexName, List<String> objectIDs, RequestOptions requestOptions)
CompletableFuture<InsightsResult>	viewedObjectIDsAsync(String eventName, String indexName, List<String> objectIDs)
CompletableFuture<InsightsResult>	viewedObjectIDsAsync(String eventName, String indexName, List<String> objectIDs, RequestOptions requestOptions)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserInsightsClient

public UserInsightsClient(String userToken,
                          InsightsClient insightsClient)

Method Detail

clickedFilters

public InsightsResult clickedFilters(@Nonnull
                                     String eventName,
                                     @Nonnull
                                     String indexName,
                                     @Nonnull
                                     List<String> filters)

Parameters:

eventName - The Event Name

indexName - The Index Name

filters - Filters parameters

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clickedFilters

public InsightsResult clickedFilters(@Nonnull
                                     String eventName,
                                     @Nonnull
                                     String indexName,
                                     @Nonnull
                                     List<String> filters,
                                     RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

filters - Filters parameters

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clickedFiltersAsync

public CompletableFuture<InsightsResult> clickedFiltersAsync(@Nonnull
                                                             String eventName,
                                                             @Nonnull
                                                             String indexName,
                                                             @Nonnull
                                                             List<String> filters)

Parameters:

eventName - The Event Name

indexName - The Index Name

filters - Filters parameters

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clickedFiltersAsync

public CompletableFuture<InsightsResult> clickedFiltersAsync(@Nonnull
                                                             String eventName,
                                                             @Nonnull
                                                             String indexName,
                                                             @Nonnull
                                                             List<String> filters,
                                                             RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

filters - Filters parameters

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clickedObjectIDs

public InsightsResult clickedObjectIDs(@Nonnull
                                       String eventName,
                                       @Nonnull
                                       String indexName,
                                       @Nonnull
                                       List<String> objectIDs)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clickedObjectIDs

public InsightsResult clickedObjectIDs(@Nonnull
                                       String eventName,
                                       @Nonnull
                                       String indexName,
                                       @Nonnull
                                       List<String> objectIDs,
                                       RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clickedObjectIDsAsync

public CompletableFuture<InsightsResult> clickedObjectIDsAsync(@Nonnull
                                                               String eventName,
                                                               @Nonnull
                                                               String indexName,
                                                               @Nonnull
                                                               List<String> objectIDs)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clickedObjectIDsAsync

public CompletableFuture<InsightsResult> clickedObjectIDsAsync(@Nonnull
                                                               String eventName,
                                                               @Nonnull
                                                               String indexName,
                                                               @Nonnull
                                                               List<String> objectIDs,
                                                               RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clickedObjectIDsAfterSearch

public InsightsResult clickedObjectIDsAfterSearch(@Nonnull
                                                  String eventName,
                                                  @Nonnull
                                                  String indexName,
                                                  @Nonnull
                                                  List<String> objectIDs,
                                                  @Nonnull
                                                  List<Long> positions,
                                                  @Nonnull
                                                  String queryID)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

positions - List of position

queryID - The query Id

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clickedObjectIDsAfterSearch

public InsightsResult clickedObjectIDsAfterSearch(@Nonnull
                                                  String eventName,
                                                  @Nonnull
                                                  String indexName,
                                                  @Nonnull
                                                  List<String> objectIDs,
                                                  @Nonnull
                                                  List<Long> positions,
                                                  @Nonnull
                                                  String queryID,
                                                  RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

positions - List of position

queryID - The query Id

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clickedObjectIDsAfterSearchAsync

public CompletableFuture<InsightsResult> clickedObjectIDsAfterSearchAsync(@Nonnull
                                                                          String eventName,
                                                                          @Nonnull
                                                                          String indexName,
                                                                          @Nonnull
                                                                          List<String> objectIDs,
                                                                          @Nonnull
                                                                          List<Long> positions,
                                                                          @Nonnull
                                                                          String queryID)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

positions - List of position

queryID - The query Id

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clickedObjectIDsAfterSearchAsync

public CompletableFuture<InsightsResult> clickedObjectIDsAfterSearchAsync(@Nonnull
                                                                          String eventName,
                                                                          @Nonnull
                                                                          String indexName,
                                                                          @Nonnull
                                                                          List<String> objectIDs,
                                                                          @Nonnull
                                                                          List<Long> positions,
                                                                          @Nonnull
                                                                          String queryID,
                                                                          RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

positions - List of position

queryID - The query Id

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedObjectIDs

public InsightsResult convertedObjectIDs(@Nonnull
                                         String eventName,
                                         @Nonnull
                                         String indexName,
                                         @Nonnull
                                         List<String> objectIDs)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedObjectIDs

public InsightsResult convertedObjectIDs(@Nonnull
                                         String eventName,
                                         @Nonnull
                                         String indexName,
                                         @Nonnull
                                         List<String> objectIDs,
                                         RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedObjectIDsAsync

public CompletableFuture<InsightsResult> convertedObjectIDsAsync(@Nonnull
                                                                 String eventName,
                                                                 @Nonnull
                                                                 String indexName,
                                                                 @Nonnull
                                                                 List<String> objectIDs)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedObjectIDsAsync

public CompletableFuture<InsightsResult> convertedObjectIDsAsync(@Nonnull
                                                                 String eventName,
                                                                 @Nonnull
                                                                 String indexName,
                                                                 @Nonnull
                                                                 List<String> objectIDs,
                                                                 RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedObjectIDsAfterSearch

public InsightsResult convertedObjectIDsAfterSearch(@Nonnull
                                                    String eventName,
                                                    @Nonnull
                                                    String indexName,
                                                    @Nonnull
                                                    List<String> objectIDs,
                                                    @Nonnull
                                                    String queryID)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

queryID - The query Id

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedObjectIDsAfterSearch

public InsightsResult convertedObjectIDsAfterSearch(@Nonnull
                                                    String eventName,
                                                    @Nonnull
                                                    String indexName,
                                                    @Nonnull
                                                    List<String> objectIDs,
                                                    @Nonnull
                                                    String queryID,
                                                    RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

queryID - The query Id

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedObjectIDsAfterSearchAsync

public CompletableFuture<InsightsResult> convertedObjectIDsAfterSearchAsync(@Nonnull
                                                                            String eventName,
                                                                            @Nonnull
                                                                            String indexName,
                                                                            @Nonnull
                                                                            List<String> objectIDs,
                                                                            @Nonnull
                                                                            String queryID)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

queryID - The query Id

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedObjectIDsAfterSearchAsync

public CompletableFuture<InsightsResult> convertedObjectIDsAfterSearchAsync(@Nonnull
                                                                            String eventName,
                                                                            @Nonnull
                                                                            String indexName,
                                                                            @Nonnull
                                                                            List<String> objectIDs,
                                                                            @Nonnull
                                                                            String queryID,
                                                                            RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

queryID - The query Id

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedFilters

public InsightsResult convertedFilters(@Nonnull
                                       String eventName,
                                       @Nonnull
                                       String indexName,
                                       @Nonnull
                                       List<String> filters)

Parameters:

eventName - The Event Name

indexName - The index name

filters - List of filters

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedFilters

public InsightsResult convertedFilters(@Nonnull
                                       String eventName,
                                       @Nonnull
                                       String indexName,
                                       @Nonnull
                                       List<String> filters,
                                       RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The index name

filters - List of filters

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedFiltersAsync

public CompletableFuture<InsightsResult> convertedFiltersAsync(@Nonnull
                                                               String eventName,
                                                               @Nonnull
                                                               String indexName,
                                                               @Nonnull
                                                               List<String> filters)

Parameters:

eventName - The Event Name

indexName - The index name

filters - List of filters

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

convertedFiltersAsync

public CompletableFuture<InsightsResult> convertedFiltersAsync(@Nonnull
                                                               String eventName,
                                                               @Nonnull
                                                               String indexName,
                                                               @Nonnull
                                                               List<String> filters,
                                                               RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The index name

filters - List of filters

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

viewedFilters

public InsightsResult viewedFilters(@Nonnull
                                    String eventName,
                                    @Nonnull
                                    String indexName,
                                    @Nonnull
                                    List<String> filters)

Parameters:

eventName - The Event Name

indexName - The Index Name

filters - Filters parameters

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

viewedFilters

public InsightsResult viewedFilters(@Nonnull
                                    String eventName,
                                    @Nonnull
                                    String indexName,
                                    @Nonnull
                                    List<String> filters,
                                    RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

filters - Filters parameters

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

viewedFiltersAsync

public CompletableFuture<InsightsResult> viewedFiltersAsync(@Nonnull
                                                            String eventName,
                                                            @Nonnull
                                                            String indexName,
                                                            @Nonnull
                                                            List<String> filters)

Parameters:

eventName - The Event Name

indexName - The Index Name

filters - Filters parameters

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

viewedFiltersAsync

public CompletableFuture<InsightsResult> viewedFiltersAsync(@Nonnull
                                                            String eventName,
                                                            @Nonnull
                                                            String indexName,
                                                            @Nonnull
                                                            List<String> filters,
                                                            RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

filters - Filters parameters

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

viewedObjectIDs

public InsightsResult viewedObjectIDs(@Nonnull
                                      String eventName,
                                      @Nonnull
                                      String indexName,
                                      @Nonnull
                                      List<String> objectIDs)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

viewedObjectIDs

public InsightsResult viewedObjectIDs(@Nonnull
                                      String eventName,
                                      @Nonnull
                                      String indexName,
                                      @Nonnull
                                      List<String> objectIDs,
                                      RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

viewedObjectIDsAsync

public CompletableFuture<InsightsResult> viewedObjectIDsAsync(@Nonnull
                                                              String eventName,
                                                              @Nonnull
                                                              String indexName,
                                                              @Nonnull
                                                              List<String> objectIDs)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

viewedObjectIDsAsync

public CompletableFuture<InsightsResult> viewedObjectIDsAsync(@Nonnull
                                                              String eventName,
                                                              @Nonnull
                                                              String indexName,
                                                              @Nonnull
                                                              List<String> objectIDs,
                                                              RequestOptions requestOptions)

Parameters:

eventName - The Event Name

indexName - The Index Name

objectIDs - List of objectId

requestOptions - RequestOptions

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization