coil-core/coil3.request/ImageRequest

ImageRequest

class ImageRequest

An immutable value object that represents a request for an image.

See also

ImageLoader.enqueue

ImageLoader.execute

Types

class Defaults(val fileSystem: FileSystem = defaultFileSystem(), val interceptorCoroutineContext: CoroutineContext = EmptyCoroutineContext, val fetcherCoroutineContext: CoroutineContext = ioCoroutineDispatcher(), val decoderCoroutineContext: CoroutineContext = ioCoroutineDispatcher(), val memoryCachePolicy: CachePolicy = CachePolicy.ENABLED, val diskCachePolicy: CachePolicy = CachePolicy.ENABLED, val networkCachePolicy: CachePolicy = CachePolicy.ENABLED, val placeholderFactory: (ImageRequest) -> Image? = EMPTY_IMAGE_FACTORY, val errorFactory: (ImageRequest) -> Image? = EMPTY_IMAGE_FACTORY, val fallbackFactory: (ImageRequest) -> Image? = EMPTY_IMAGE_FACTORY, val sizeResolver: SizeResolver = SizeResolver.ORIGINAL, val scale: Scale = Scale.FIT, val precision: Precision = Precision.EXACT, val extras: Extras = Extras.EMPTY)

A set of default options that are used to fill in unset ImageRequest values.

class Defined(val fileSystem: FileSystem?, val interceptorCoroutineContext: CoroutineContext?, val fetcherCoroutineContext: CoroutineContext?, val decoderCoroutineContext: CoroutineContext?, val memoryCachePolicy: CachePolicy?, val diskCachePolicy: CachePolicy?, val networkCachePolicy: CachePolicy?, val placeholderFactory: (ImageRequest) -> Image??, val errorFactory: (ImageRequest) -> Image??, val fallbackFactory: (ImageRequest) -> Image??, val sizeResolver: SizeResolver?, val scale: Scale?, val precision: Precision?)

Tracks which values have been set (instead of computed automatically using a default) when building an ImageRequest.

interface Listener

A set of callbacks for an ImageRequest.

Properties

addLastModifiedToFileCacheKey

val ImageRequest.addLastModifiedToFileCacheKey: Boolean

val context: PlatformContext

crossfadeMillis

expect val ImageRequest.crossfadeMillis: Int

actual val ImageRequest.crossfadeMillis: Int

decoderCoroutineContext

val decoderCoroutineContext: CoroutineContext

val decoderFactory: Decoder.Factory?

val defaults: ImageRequest.Defaults

The defaults used to fill unset values.

val defined: ImageRequest.Defined

The raw values set on Builder.

val diskCacheKey: String?

diskCachePolicy

val diskCachePolicy: CachePolicy

val errorFactory: (ImageRequest) -> Image?

val extras: Extras

fallbackFactory

val fallbackFactory: (ImageRequest) -> Image?

fetcherCoroutineContext

val fetcherCoroutineContext: CoroutineContext

val fetcherFactory: Pair<Fetcher.Factory<*>, KClass<*>>?

val fileSystem: FileSystem

interceptorCoroutineContext

val interceptorCoroutineContext: CoroutineContext

val listener: ImageRequest.Listener?

val ImageRequest.maxBitmapSize: Size

val memoryCacheKey: String?

memoryCacheKeyExtras

val memoryCacheKeyExtras: Map<String, String>

memoryCachePolicy

val memoryCachePolicy: CachePolicy

networkCachePolicy

val networkCachePolicy: CachePolicy

placeholderFactory

val placeholderFactory: (ImageRequest) -> Image?

placeholderMemoryCacheKey

val placeholderMemoryCacheKey: MemoryCache.Key?

val precision: Precision

val scale: Scale

val sizeResolver: SizeResolver

val target: Target?

Functions

fun error(): Image?

Create and return a new error image.

fun fallback(): Image?

Create and return a new fallback image.

fun <T> ImageRequest.getExtra(key: Extras.Key<T>): T

fun newBuilder(context: PlatformContext = this.context): ImageRequest.Builder

fun placeholder(): Image?

Create and return a new placeholder image.