coil-core/coil3.request/ImageRequest/Builder

Builder

Constructors

constructor(context: PlatformContext)

constructor(request: ImageRequest, context: PlatformContext = request.context)

Properties

val extras: Extras.Builder

Functions

fun build(): ImageRequest

Create a new ImageRequest.

fun ImageRequest.Builder.crossfade(enable: Boolean): ImageRequest.Builder

Enable a crossfade animation when a request completes successfully.

expect fun ImageRequest.Builder.crossfade(durationMillis: Int): ImageRequest.Builder

actual fun ImageRequest.Builder.crossfade(durationMillis: Int): ImageRequest.Builder

Enable a crossfade animation when a request completes successfully.

fun data(data: Any?): ImageRequest.Builder

Set the data to load.

decoderDispatcher

fun decoderDispatcher(dispatcher: CoroutineContext): ImageRequest.Builder

fun decoderFactory(factory: Decoder.Factory): ImageRequest.Builder

Use factory to handle decoding any image data.

fun defaults(defaults: ImageRequest.Defaults): ImageRequest.Builder

Set the defaults for any unset request values.

fun diskCacheKey(key: String?): ImageRequest.Builder

Set the disk cache key for this request.

diskCachePolicy

fun diskCachePolicy(policy: CachePolicy): ImageRequest.Builder

Enable/disable reading/writing from/to the disk cache.

fun dispatcher(dispatcher: CoroutineContext): ImageRequest.Builder

fun error(image: Image?): ImageRequest.Builder

fun error(factory: (ImageRequest) -> Image?): ImageRequest.Builder

Set the error image to use if the request fails.

fun fallback(image: Image?): ImageRequest.Builder

fun fallback(factory: (ImageRequest) -> Image?): ImageRequest.Builder

Set the fallback image to use if data is null.

fetcherDispatcher

fun fetcherDispatcher(dispatcher: CoroutineContext): ImageRequest.Builder

inline fun <T : Any> fetcherFactory(factory: Fetcher.Factory<T>): ImageRequest.Builder

fun <T : Any> fetcherFactory(factory: Fetcher.Factory<T>, type: KClass<T>): ImageRequest.Builder

Use factory to handle fetching any image data.

fun fileSystem(fileSystem: FileSystem): ImageRequest.Builder

The FileSystem that will be used to perform any disk read/write operations.

interceptorDispatcher

fun interceptorDispatcher(dispatcher: CoroutineContext): ImageRequest.Builder

fun listener(listener: ImageRequest.Listener?): ImageRequest.Builder

Set the Listener.

inline fun listener(crossinline onStart: (request: ImageRequest) -> Unit = {}, crossinline onCancel: (request: ImageRequest) -> Unit = {}, crossinline onError: (request: ImageRequest, result: ErrorResult) -> Unit = { _, _ -> }, crossinline onSuccess: (request: ImageRequest, result: SuccessResult) -> Unit = { _, _ -> }): ImageRequest.Builder

Convenience function to create and set the Listener.

fun memoryCacheKey(key: MemoryCache.Key?): ImageRequest.Builder

fun memoryCacheKey(key: String?): ImageRequest.Builder

Set the memory cache key for this request.

memoryCacheKeyExtra

fun memoryCacheKeyExtra(key: String, value: String?): ImageRequest.Builder

Set extra values to be added to this image request's memory cache key.

memoryCacheKeyExtras

fun memoryCacheKeyExtras(extras: Map<String, String>): ImageRequest.Builder

Set extra values to be added to this image request's memory cache key.

memoryCachePolicy

fun memoryCachePolicy(policy: CachePolicy): ImageRequest.Builder

Enable/disable reading/writing from/to the memory cache.

networkCachePolicy

fun networkCachePolicy(policy: CachePolicy): ImageRequest.Builder

Enable/disable reading from the network.

fun placeholder(image: Image?): ImageRequest.Builder

fun placeholder(factory: (ImageRequest) -> Image?): ImageRequest.Builder

Set the placeholder image to use when the request starts.

placeholderMemoryCacheKey

fun placeholderMemoryCacheKey(key: MemoryCache.Key?): ImageRequest.Builder

Set the memory cache key whose value will be used as the placeholder image.

fun placeholderMemoryCacheKey(key: String?): ImageRequest.Builder

Set the memory cache key whose value will be used as the placeholder drawable.

fun precision(precision: Precision): ImageRequest.Builder

Set the precision for the size of the loaded image.

fun scale(scale: Scale): ImageRequest.Builder

Set the scaling algorithm that will be used to fit/fill the image into the size provided by sizeResolver.

fun size(size: Size): ImageRequest.Builder

fun size(size: Int): ImageRequest.Builder

fun size(width: Dimension, height: Dimension): ImageRequest.Builder

fun size(width: Int, height: Int): ImageRequest.Builder

Set the requested width/height.

fun size(resolver: SizeResolver): ImageRequest.Builder

Set the SizeResolver to resolve the requested width/height.

fun target(target: Target?): ImageRequest.Builder

Set the Target.

inline fun target(crossinline onStart: (placeholder: Image?) -> Unit = {}, crossinline onError: (error: Image?) -> Unit = {}, crossinline onSuccess: (result: Image) -> Unit = {}): ImageRequest.Builder

Convenience function to create and set the Target.