Adswizz SDK API/com.adswizz.common/AdswizzHttpConfig

AdswizzHttpConfig

class AdswizzHttpConfig

An HTTP configuration options that can be passed to Ad Request & Ad Reporting classes.

Instances are obtained through Builder class. Any property left unset on the builder remains null, in that case, the fallback are the default values of the SDK's HTTP networking engine.

Example:

val config = AdswizzHttpConfig.Builder()
    .setConnectionTimeout(java.time.Duration.ofSeconds(5))
    .setResponseTimeout(java.time.Duration.ofSeconds(10))
    .setRedirectsPolicy(AdswizzHttpConfig.RedirectPolicy.NORMAL)
    .setCookiePolicy(AdswizzHttpConfig.CookiePolicy.ACCEPT_ORIGINAL_SERVER)
    .setHeaders(mapOf("X-Custom" to "value"))
    .build()

Types

Builder for AdswizzHttpConfig. All setters are optional; properties not set remain null.

enum CookiePolicy : Enum<AdswizzHttpConfig.CookiePolicy>

Policy controlling which cookies are accepted from server responses.

enum RedirectPolicy : Enum<AdswizzHttpConfig.RedirectPolicy>

Policy controlling how HTTP redirects (3xx responses) are handled.

Properties

connectionTimeout

val connectionTimeout: Duration?

Optional maximum time to wait while establishing a connection.

val cookiePolicy: AdswizzHttpConfig.CookiePolicy?

Optional policy controlling whether cookies are accepted or not. See CookiePolicy.

val headers: Map<String, String>?

Optional HTTP headers added to every request.

redirectsPolicy

val redirectsPolicy: AdswizzHttpConfig.RedirectPolicy?

Optional policy controlling how HTTP redirects are followed. See RedirectPolicy.

responseTimeout

val responseTimeout: Duration?

Optional maximum time to wait for the response after the request has been sent.

Functions

fun copy(): AdswizzHttpConfig.Builder

Returns a new Builder pre-populated with the values of this configuration.