Builder

class Builder

Constructors

Builder

fun Builder(context: Context)

Functions

addLastModifiedToFileCacheKey

fun addLastModifiedToFileCacheKey(enable: Boolean): <ERROR CLASS>

Enables adding File.lastModified to the memory cache key when loading an image from a File.

allowHardware

fun allowHardware(enable: Boolean): <ERROR CLASS>

Allow the use of Bitmap.Config.HARDWARE.

allowRgb565

fun allowRgb565(enable: Boolean): <ERROR CLASS>

Allow automatically using Bitmap.Config.RGB_565 when an image is guaranteed to not have alpha.

bitmapConfig

fun bitmapConfig(bitmapConfig: Bitmap.Config): <ERROR CLASS>

Set the preferred Bitmap.Config.

bitmapFactoryExifOrientationPolicy

fun bitmapFactoryExifOrientationPolicy(policy: ExifOrientationPolicy): <ERROR CLASS>

Sets the policy for handling the EXIF orientation flag for images decoded by BitmapFactoryDecoder.

bitmapFactoryMaxParallelism

fun bitmapFactoryMaxParallelism(maxParallelism: Int): <ERROR CLASS>

Sets the maximum number of parallel BitmapFactory decode operations at once.

build

fun build(): ImageLoader

Create a new ImageLoader instance.

callFactory

fun callFactory(initializer: () -> Call.Factory): <ERROR CLASS>

Set a lazy callback to create the Call.Factory used for network requests.

fun callFactory(callFactory: Call.Factory): <ERROR CLASS>

Set the Call.Factory used for network requests.

components

fun components(components: ComponentRegistry): <ERROR CLASS>

Set the ComponentRegistry.

inline fun components(builder: ComponentRegistry.Builder.() -> Unit): <ERROR CLASS>

Build and set the ComponentRegistry.

crossfade

fun crossfade(enable: Boolean): <ERROR CLASS>

Enable a crossfade animation with duration CrossfadeDrawable.DEFAULT_DURATION milliseconds when a request completes successfully.

fun crossfade(durationMillis: Int): <ERROR CLASS>

Enable a crossfade animation with durationMillis milliseconds when a request completes successfully.

decoderDispatcher

fun decoderDispatcher(dispatcher: CoroutineDispatcher): <ERROR CLASS>

The CoroutineDispatcher that Decoder.decode will be executed on.

diskCache

fun diskCache(diskCache: DiskCache?): <ERROR CLASS>

Set the DiskCache.

fun diskCache(initializer: () -> DiskCache?): <ERROR CLASS>

Set a lazy callback to create the DiskCache.

diskCachePolicy

fun diskCachePolicy(policy: CachePolicy): <ERROR CLASS>

Set the default disk cache policy.

dispatcher

fun dispatcher(dispatcher: CoroutineDispatcher): <ERROR CLASS>

A convenience function to set fetcherDispatcher, decoderDispatcher, and transformationDispatcher in one call.

error

fun error(drawable: Drawable?): <ERROR CLASS>

Set the default error drawable to use when a request fails.

fun error(@DrawableRes() drawableResId: Int): <ERROR CLASS>

Set the default error drawable to use when a request fails.

eventListener

fun eventListener(listener: EventListener): <ERROR CLASS>

Set a single EventListener that will receive all callbacks for requests launched by this image loader.

eventListenerFactory

fun eventListenerFactory(factory: EventListener.Factory): <ERROR CLASS>

Set the EventListener.Factory to create per-request EventListeners.

fallback

fun fallback(drawable: Drawable?): <ERROR CLASS>

Set the default fallback drawable to use if ImageRequest.data is null.

fun fallback(@DrawableRes() drawableResId: Int): <ERROR CLASS>

Set the default fallback drawable to use if ImageRequest.data is null.

fetcherDispatcher

fun fetcherDispatcher(dispatcher: CoroutineDispatcher): <ERROR CLASS>

The CoroutineDispatcher that Fetcher.fetch will be executed on.

interceptorDispatcher

fun interceptorDispatcher(dispatcher: CoroutineDispatcher): <ERROR CLASS>

The CoroutineDispatcher that the Interceptor chain will be executed on.

logger

fun logger(logger: Logger?): <ERROR CLASS>

Set the Logger to write logs to.

memoryCache

fun memoryCache(memoryCache: MemoryCache?): <ERROR CLASS>

Set the MemoryCache.

fun memoryCache(initializer: () -> MemoryCache?): <ERROR CLASS>

Set a lazy callback to create the MemoryCache.

memoryCachePolicy

fun memoryCachePolicy(policy: CachePolicy): <ERROR CLASS>

Set the default memory cache policy.

networkCachePolicy

fun networkCachePolicy(policy: CachePolicy): <ERROR CLASS>

Set the default network cache policy.

networkObserverEnabled

fun networkObserverEnabled(enable: Boolean): <ERROR CLASS>

Enables short circuiting network requests if the device is offline.

okHttpClient

fun okHttpClient(initializer: () -> OkHttpClient): <ERROR CLASS>

Set a lazy callback to create the OkHttpClient used for network requests.

fun okHttpClient(okHttpClient: OkHttpClient): <ERROR CLASS>

Set the OkHttpClient used for network requests.

placeholder

fun placeholder(drawable: Drawable?): <ERROR CLASS>

Set the default placeholder drawable to use when a request starts.

fun placeholder(@DrawableRes() drawableResId: Int): <ERROR CLASS>

Set the default placeholder drawable to use when a request starts.

precision

fun precision(precision: Precision): <ERROR CLASS>

Set the default precision for a request.

respectCacheHeaders

fun respectCacheHeaders(enable: Boolean): <ERROR CLASS>

Enables support for network cache headers.

transformationDispatcher

fun transformationDispatcher(dispatcher: CoroutineDispatcher): <ERROR CLASS>

The CoroutineDispatcher that Transformation.transform will be executed on.

transitionFactory

fun transitionFactory(factory: Transition.Factory): <ERROR CLASS>

Set the default Transition.Factory for each request.