InsightsClient class final

Implemented types

• ApiClient

Constructors

InsightsClient({required String appId, required String apiKey, ClientOptions options = const ClientOptions(), String? region})

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 setter, inherited

options → ClientOptions

A set of custom client options to configure the behavior of the API client.

final

region → String?

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

customDelete({required String path, Map<String, Object>? parameters, RequestOptions? requestOptions}) → Future<Object>

This method allow you to send requests to the Algolia REST API.

customGet({required String path, Map<String, Object>? parameters, RequestOptions? requestOptions}) → Future<Object>

This method allow you to send requests to the Algolia REST API.

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.

customPut({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.

del({required String path, Map<String, Object>? parameters, Object? body, RequestOptions? requestOptions}) → Future<Object>

deleteUserToken({required String userToken, RequestOptions? requestOptions}) → Future<void>

Deletes all events related to the specified user token from events metrics and analytics. To delete a personalization user profile, see Delete a user profile.

dispose() → void

Dispose of underlying resources.

override

get({required String path, Map<String, Object>? parameters, Object? body, RequestOptions? requestOptions}) → Future<Object>

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>

pushEvents({required InsightsEvents insightsEvents, RequestOptions? requestOptions}) → Future<EventsResponse>

Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.

put({required String path, Map<String, Object>? parameters, Object? body, RequestOptions? requestOptions}) → Future<Object>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited