com.tomtom.sdk.http:http-core/com.tomtom.sdk.http.url/HttpUrlBuilder

HttpUrlBuilder

class HttpUrlBuilder

A builder for constructing HTTP URLs. This class allows for the configuration of scheme, host, port, path and query parameters to build a URI.

This class provides a fluent interface for method chaining.

Example of usage: url("https://api.tomtom.com/search/2/search/amsterdam.json?key=123&lat=52.3&lon=5.1") { path("/search/2/search") queryParams { remove("key") "token" to "xyz" } } // -> https://api.tomtom.com/search/2/search/amsterdam.json?lat=52.3&lon=5.1&token=xyz

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

constructor()

Types

object Companion

QueryParametersBuilder

class QueryParametersBuilder

Functions

addAllQueryParams

fun addAllQueryParams(queryParamValues: Map<String, String>): HttpUrlBuilder

Adds multiple query parameters to the URL.

addOrReplaceQueryParam

fun addOrReplaceQueryParam(param: String, value: String): HttpUrlBuilder

Adds a query parameter to the URL or replaces it if it already exists.

fun addQueryParam(param: String, value: String): HttpUrlBuilder

Adds a query parameter to the URL.

fun build(): URI

Constructs the URI from the configured URL parts.

fun host(host: String): HttpUrlBuilder

Sets the host of the URL.

fun path(path: String): HttpUrlBuilder

Sets the path of the URL. Optional parameter. Default value is /.

fun port(port: Int): HttpUrlBuilder

Sets the port of the URL. Optional parameter.

fun query(query: String): HttpUrlBuilder

Sets the query string of the URL. Optional parameter.

fun queryParams(init: HttpUrlBuilder.QueryParametersBuilder.() -> Unit): HttpUrlBuilder

Applies a configuration block to the query parameters of the URL.

removeAllQueryParams

fun removeAllQueryParams(): HttpUrlBuilder

Removes all query parameters from the URL.

removeQueryParam

fun removeQueryParam(param: String): HttpUrlBuilder

Removes a query parameter from the URL.

fun scheme(scheme: String): HttpUrlBuilder

Sets the scheme of the URL. Optional parameter. Default value is https.