com.algolia.search

Class SyncInsightsClient

java.lang.Object

com.algolia.search.SyncInsightsClient

public class SyncInsightsClient
extends Object

Insights client

Constructor Summary

Constructors

Constructor and Description
SyncInsightsClient(InsightsConfig config, APIClient client)
SyncInsightsClient(String applicationId, String apiKey, APIClient client)
SyncInsightsClient(String applicationId, String apiKey, String region, APIClient client)

Method Summary

Modifier and Type	Method and Description
InsightsResult	sendEvent(InsightsEvent event) This command pushes an event to the Insights API.
InsightsResult	sendEvent(InsightsEvent event, RequestOptions requestOptions) This command pushes an event to the Insights API.
InsightsResult	sendEvents(List<InsightsEvent> events) This command pushes an array of events to the Insights API.
InsightsResult	sendEvents(List<InsightsEvent> events, RequestOptions requestOptions) This command pushes an array of events to the Insights API.
SyncUserInsightsClient	user(String userToken)

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncInsightsClient

public SyncInsightsClient(@Nonnull
                          String applicationId,
                          @Nonnull
                          String apiKey,
                          @Nonnull
                          APIClient client)

Parameters:

applicationId - The application ID

apiKey - The API Key

client - API Client

SyncInsightsClient

public SyncInsightsClient(@Nonnull
                          String applicationId,
                          @Nonnull
                          String apiKey,
                          @Nonnull
                          String region,
                          @Nonnull
                          APIClient client)

Parameters:

applicationId - The applicationID

apiKey - The api KEY

region - The server region

client - APIClient

SyncInsightsClient

public SyncInsightsClient(@Nonnull
                          InsightsConfig config,
                          @Nonnull
                          APIClient client)

Parameters:

config - InsightsClient

client - APIClient

Method Detail

user

public SyncUserInsightsClient user(@Nonnull
                                   String userToken)

Parameters:

userToken - the user config

sendEvent

public InsightsResult sendEvent(@Nonnull
                                InsightsEvent event)
                         throws AlgoliaException

This command pushes an event to the Insights API.

Parameters:

event - An event

Throws:

AlgoliaException - If APi Error

sendEvent

public InsightsResult sendEvent(@Nonnull
                                InsightsEvent event,
                                @Nonnull
                                RequestOptions requestOptions)
                         throws AlgoliaException

This command pushes an event to the Insights API.

Parameters:

event - An event

requestOptions - RequestOptions

Throws:

AlgoliaException - If APi Error

sendEvents

public InsightsResult sendEvents(@Nonnull
                                 List<InsightsEvent> events)
                          throws AlgoliaException

This command pushes an array of events to the Insights API.

Parameters:

events - List of events

Throws:

AlgoliaException - If APi Error

sendEvents

public InsightsResult sendEvents(@Nonnull
                                 List<InsightsEvent> events,
                                 @Nonnull
                                 RequestOptions requestOptions)
                          throws AlgoliaException

This command pushes an array of events to the Insights API.

Parameters:

events - List of events

requestOptions - RequestOptions

Throws:

AlgoliaException - If APi Error