coil-network-core/coil3.network

Package-level declarations

Types

CacheNetworkResponse

@InternalCoilApi

object CacheNetworkResponse

Utility methods used to read/write a NetworkResponse from/to the disk cache.

@ExperimentalCoilApi

interface CacheStrategy

Controls the behavior around reading/writing responses from/to the disk cache.

ConnectivityChecker

@ExperimentalCoilApi

fun interface ConnectivityChecker

Determines if the device is able to access the internet.

class HttpException(val response: NetworkResponse) : RuntimeException

Exception for an unexpected, non-2xx HTTP response.

interface NetworkClient

An asynchronous HTTP client that executes NetworkRequests and returns NetworkResponses.

class NetworkFetcher(url: String, options: Options, networkClient: Lazy<NetworkClient>, diskCache: Lazy<DiskCache?>, cacheStrategy: Lazy<CacheStrategy>, connectivityChecker: ConnectivityChecker) : Fetcher

A Fetcher that fetches and caches images from the network.

@Poko

class NetworkHeaders

A list of HTTP headers.

@Poko

class NetworkRequest(val url: String, val method: String = HTTP_METHOD_GET, val headers: NetworkHeaders = NetworkHeaders.EMPTY, val body: NetworkRequestBody? = null, val extras: Extras = Extras.EMPTY)

Represents an HTTP request.

NetworkRequestBody

interface NetworkRequestBody

NetworkResponse

@Poko

class NetworkResponse(val code: Int = HTTP_RESPONSE_OK, val requestMillis: Long = 0, val responseMillis: Long = 0, val headers: NetworkHeaders = NetworkHeaders.EMPTY, val body: NetworkResponseBody? = null, val delegate: Any? = null)

Represents an HTTP response.

NetworkResponseBody

interface NetworkResponseBody : AutoCloseable

Properties

val Extras.Key.Companion.httpBody: Extras.Key<NetworkRequestBody?>

val ImageRequest.httpBody: NetworkRequestBody?

val Options.httpBody: NetworkRequestBody?

val Extras.Key.Companion.httpHeaders: Extras.Key<NetworkHeaders>

val ImageRequest.httpHeaders: NetworkHeaders

val Options.httpHeaders: NetworkHeaders

val Extras.Key.Companion.httpMethod: Extras.Key<String>

val ImageRequest.httpMethod: String

val Options.httpMethod: String

Functions

ConnectivityChecker

@ExperimentalCoilApi

expect fun ConnectivityChecker(context: PlatformContext): ConnectivityChecker

actual fun ConnectivityChecker(context: PlatformContext): ConnectivityChecker

fun ImageRequest.Builder.httpBody(body: NetworkRequestBody): ImageRequest.Builder

Set the HTTP request body for any network operations performed by this image request.

fun ImageRequest.Builder.httpHeaders(headers: NetworkHeaders): ImageRequest.Builder

Set the HTTP request headers for any network operations performed by this image request.

fun ImageRequest.Builder.httpMethod(method: String): ImageRequest.Builder

Set the HTTP request method for any network operations performed by this image request.

NetworkRequestBody

fun NetworkRequestBody(bytes: ByteString): NetworkRequestBody

NetworkResponseBody

fun NetworkResponseBody(source: BufferedSource): NetworkResponseBody