Package-level declarations

Types

Link copied to clipboard
class OpenCageForwardEndpoint(apiKey: String, parameters: OpenCageParameters = OpenCageParameters()) : HttpApiEndpoint<String, List<Coordinates>>

A ForwardEndpoint that uses the OpenCage Geocoding API.

Link copied to clipboard

Defines a HttpApiPlatformGeocoder that uses the OpenCage Geocoding API.

Link copied to clipboard
class OpenCageReverseEndpoint(apiKey: String, parameters: OpenCageParameters = OpenCageParameters()) : HttpApiEndpoint<Coordinates, List<Place>>

A ReverseEndpoint that uses the OpenCage Geocoding API.

Functions

Link copied to clipboard
fun PlatformGeocoder.Companion.openCage(apiKey: String, parameters: OpenCageParameters = OpenCageParameters(), json: Json = HttpApiEndpoint.json(), client: HttpClient = HttpApiEndpoint.httpClient(json)): OpenCagePlatformGeocoder
fun PlatformGeocoder.Companion.openCage(apiKey: String, json: Json = HttpApiEndpoint.json(), client: HttpClient = HttpApiEndpoint.httpClient(json), block: OpenCageParametersBuilder.() -> Unit): OpenCagePlatformGeocoder

Creates a OpenCagePlatformGeocoder to be used with the Geocoder.

Link copied to clipboard
fun OpenCagePlatformGeocoder(apiKey: String, parameters: OpenCageParameters = OpenCageParameters(), json: Json = HttpApiEndpoint.json(), client: HttpClient = HttpApiEndpoint.httpClient(json)): OpenCagePlatformGeocoder
fun OpenCagePlatformGeocoder(apiKey: String, json: Json = HttpApiEndpoint.json(), client: HttpClient = HttpApiEndpoint.httpClient(json), block: OpenCageParametersBuilder.() -> Unit): OpenCagePlatformGeocoder

Creates a OpenCagePlatformGeocoder to be used with the Geocoder.