Core/io.telereso.kmp.core/Config/Builder

Builder

data class Builder(val appName: String, val appVersion: String)

We may need to pass some compulsory values to the builder. Mandatory param values are part of the constructor.

Parameters

appName

mandatory param for the current app name that is using the client

appVersion

mandatory param for the current app version of client

Constructors

Builder

constructor(appName: String, appVersion: String)

Properties

appName

val appName: String

appVersion

val appVersion: String

connectTimeoutMillis

var connectTimeoutMillis: Long

environment

var environment: Environment?

host

var host: String?

interceptors

var interceptors: List<Any?>?

logHttpRequests

var logHttpRequests: Boolean

protocol

var protocol: String?

requestTimeoutMillis

var requestTimeoutMillis: Long

Functions

build

fun build(): Config

shouldLogHttpRequests

fun shouldLogHttpRequests(value: Boolean): Config.Builder

should log https requests

withConnectTimeoutInMillis

fun withConnectTimeoutInMillis(value: Int): Config.Builder

set HttpTimeout connection Timeout in Millis If not set, it will default to CONNECTION_TIME_OUT_MILLIS in constant as default

withEnvironment

fun withEnvironment(value: Environment?): Config.Builder

set the build enviroment if not set, it will default to Environment.STAGING as default

withHost

fun withHost(protocol: String?, host: String?): Config.Builder

Ktor url builder must provide a protocol else it defaults to HTTP. Client can only need to send us the url path.

withInterceptors

fun withInterceptors(value: List<Any?>?): Config.Builder

all our optional values

withRequestTimeoutInMillis

fun withRequestTimeoutInMillis(value: Int): Config.Builder

set HttpTimeout request Timeout in Millis