jchucomponents-network/com.jeluchu.jchucomponents.network.http

Package-level declarations

Types

data class HttpClientConfiguration(val baseUrl: String = "", val isLenient: Boolean = true, val enableCache: Boolean = true, val expectSuccess: Boolean = true, val enableLogging: Boolean = false, val coerceInputValues: Boolean = true, val ignoreUnknownKeys: Boolean = true, val defaultHeaders: Map<String, String> = emptyMap(), val socketTimeoutMillis: Long = DEFAULT_TIMEOUT_MILLIS, val requestTimeoutMillis: Long = DEFAULT_TIMEOUT_MILLIS, val connectTimeoutMillis: Long = DEFAULT_TIMEOUT_MILLIS, val logLevel: HttpClientLogLevel = HttpClientLogLevel.ALL, val sensitiveHeaders: Set<String> = setOf("Authorization"))

Shared configuration for the Ktor client created by createHttpClient.

HttpClientLogLevel

enum HttpClientLogLevel : Enum<HttpClientLogLevel>

Logging detail used by clients created with createHttpClient.

HttpStatusCode

enum HttpStatusCode : Enum<HttpStatusCode>

This is a list of Hypertext Transfer Protocol (HTTP) response status codes.

Functions

createHttpClient

fun createHttpClient(configuration: HttpClientConfiguration = HttpClientConfiguration()): HttpClient

Creates a configured Ktor client backed by the Android engine on Android and the Darwin engine on Apple platforms.

getHttpErrorInfo

fun getHttpErrorInfo(code: Int): HttpStatusCode

getRequest

inline suspend fun <T> HttpClient.getRequest(endpoint: ApiEndpoint): T

inline suspend fun <T> HttpClient.getRequest(url: String): T

path

fun ApiEndpoint.path(): String

postRequest

inline suspend fun <T> HttpClient.postRequest(endpoint: ApiEndpoint, payload: Any? = null, headers: Map<String, String> = emptyMap()): T

inline suspend fun <T> HttpClient.postRequest(url: String, payload: Any, headers: Map<String, String> = emptyMap()): T

putRequest

inline suspend fun <T> HttpClient.putRequest(endpoint: ApiEndpoint, payload: Any, headers: Map<String, String> = emptyMap()): T

inline suspend fun <T> HttpClient.putRequest(url: String, payload: Any, headers: Map<String, String> = emptyMap()): T

uploadMultipartRequest

inline suspend fun <T> HttpClient.uploadMultipartRequest(endpoint: ApiEndpoint, formData: MultiPartFormDataContent, headers: Map<String, String> = emptyMap()): T

inline suspend fun <T> HttpClient.uploadMultipartRequest(url: String, formData: MultiPartFormDataContent, headers: Map<String, String> = emptyMap()): T