NominatimConfiguration class

NominatimConfiguration provides a centralized configuration for managing settings related to the Nominatim API and Dio's cache interceptors.

This class serves as the primary point to control the behavior of caching and other configurations for the Nominatim API integration within the application. The settings defined here can be dynamically adjusted based on the app's requirements.

Constructors

NominatimConfiguration.new()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

baseUrl ↔ String?

Specifies the base URL for the Nominatim API. Defaults to the official OpenStreetMap Nominatim instance.

getter/setter pair

convertFormData ↔ bool

Whether to convert FormData into a JSON-like structure for logging purposes.

getter/setter pair

enableCurlLog ↔ bool?

Indicates whether cURL logs should be displayed for HTTP requests.

getter/setter pair

maxStale ↔ Duration?

Defines the maximum duration after which a cached response is considered stale. Once this duration is exceeded, the cache will no longer be used, and a fresh network request will be triggered.

getter/setter pair

printOnSuccess ↔ bool?

Whether to log cURL commands for successful HTTP responses.

getter/setter pair

useCacheInterceptor ↔ bool?

Indicates whether the cache interceptor should be enabled for HTTP requests.

getter/setter pair

userAgent ↔ String?

Specifies the User-Agent string to be used for HTTP requests to the Nominatim API.

getter/setter pair