Algolia class

Constructors

Algolia.init({required String applicationId, required String apiKey, Map<String, String> extraHeaders = const {}, List<String> extraUserAgents = const []})
Algolia is a class that has a constructor init() that takes in a applicationId, apiKey, extraHeaders and extraUserAgents.
const

Properties

applicationId → String
A variable that is used to store the application id.
final
extraHeaders → Map<String, String>
Used to store the extra headers that are passed in the constructor.
final
extraUserAgents → List<String>
Used to add extra user agents to the request.
final
hashCode → int
The hash code for this object.
no setterinherited
instance → Algolia
A getter that returns a new instance of Algolia.
no setter
multipleQueries → AlgoliaMultiIndexesReference
A getter that returns a new instance of AlgoliaMultiIndexesReference.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getIndices() → Future<AlgoliaIndexesSnapshot>
It makes a GET request to the /1/indexes endpoint, and returns an AlgoliaIndexesSnapshot object
index(String index) → AlgoliaIndexReference
Return an AlgoliaIndexReference object that is a reference to the index with the given name.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pushEvents(List<AlgoliaEvent> events) → Future<void>
Pushes an array of events to the Insights API.
setHeader(String key, String value) → Algolia
The setHeader function takes in a key and value and returns a new instance of Algolia with the extraHeaders updated
toString() → String
A string representation of this object.
inherited

Operators

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

Static Properties

version → String
Version of the package.
final