ClientOptions class final

Constructors

ClientOptions.new({Duration connectTimeout = const Duration(seconds: 2), Duration writeTimeout = const Duration(seconds: 30), Duration readTimeout = const Duration(seconds: 5), Iterable<Host>? hosts, Map<String, dynamic>? headers, Iterable<AgentSegment>? agentSegments, Requester? requester, dynamic logger(Object?)?, Iterable<Interceptor>? interceptors, HttpClientAdapter? httpClientAdapter})

Constructs a ClientOptions instance with the provided parameters.

const

Properties

agentSegments → Iterable<AgentSegment>?

List of agent segments for the Algolia service.

final

connectTimeout → Duration

The maximum duration to wait for a connection to establish before timing out.

final

hashCode → int

The hash code for this object.

no setter, override

headers → Map<String, dynamic>?

Default headers to include in each HTTP request.

final

hosts → Iterable<Host>?

The list of hosts that the client can connect to.

final

httpClientAdapter → HttpClientAdapter?

Custom HttpClientAdapter used to send HTTP requests. Used only in case of using the default (dio) requester.

final

interceptors → Iterable<Interceptor>?

List of Dio interceptors. Used only in case of using the default (dio) requester.

final

logger → dynamic Function(Object?)?

Custom logger for http operations.

final

readTimeout → Duration

The maximum duration to wait for a read operation to complete before timing out.

final

requester → Requester?

Custom requester used to send HTTP requests.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

writeTimeout → Duration

The maximum duration to wait for a write operation to complete before timing out.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override