Builder

class Builder

Constructors

Builder

fun Builder(context: Context)

Functions

addLastModifiedToFileCacheKey

fun addLastModifiedToFileCacheKey(enable: Boolean): ImageLoader.Builder

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

allowHardware

fun allowHardware(enable: Boolean): ImageLoader.Builder

Allow the use of Bitmap.Config.HARDWARE.

allowRgb565

fun allowRgb565(enable: Boolean): ImageLoader.Builder

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

availableMemoryPercentage

fun availableMemoryPercentage(@FloatRange(from = 0.0.toDouble(), to = 1.0.toDouble()) percent: Double): ImageLoader.Builder

Set the percentage of available memory to devote to this ImageLoader's memory cache and bitmap pool.

bitmapConfig

fun bitmapConfig(bitmapConfig: Bitmap.Config): ImageLoader.Builder

Set the preferred Bitmap.Config.

bitmapPoolingEnabled

fun bitmapPoolingEnabled(enable: Boolean): ImageLoader.Builder

Enables counting references to bitmaps so they can be automatically reused by a BitmapPool when their reference count reaches zero.

bitmapPoolPercentage

fun bitmapPoolPercentage(@FloatRange(from = 0.0.toDouble(), to = 1.0.toDouble()) percent: Double): ImageLoader.Builder

Set the percentage of memory allocated to this ImageLoader to allocate to bitmap pooling.

build

fun build(): ImageLoader

Create a new ImageLoader instance.

callFactory

fun callFactory(initializer: () -> Call.Factory): ImageLoader.Builder

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

fun callFactory(callFactory: Call.Factory): ImageLoader.Builder

Set the Call.Factory used for network requests.

componentRegistry

fun componentRegistry(registry: ComponentRegistry): ImageLoader.Builder

Set the ComponentRegistry.

inline fun componentRegistry(builder: ComponentRegistry.Builder.() -> Unit): ImageLoader.Builder

Build and set the ComponentRegistry.

crossfade

fun crossfade(enable: Boolean): ImageLoader.Builder

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

fun crossfade(durationMillis: Int): ImageLoader.Builder

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

diskCachePolicy

fun diskCachePolicy(policy: CachePolicy): ImageLoader.Builder

Set the default disk cache policy.

dispatcher

fun dispatcher(dispatcher: CoroutineDispatcher): ImageLoader.Builder

The default CoroutineDispatcher to run image requests on.

error

fun error(drawable: Drawable?): ImageLoader.Builder

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

fun error(@DrawableRes() drawableResId: Int): ImageLoader.Builder

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

eventListener

fun eventListener(factory: EventListener.Factory): ImageLoader.Builder

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

fun eventListener(listener: EventListener): ImageLoader.Builder

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

fallback

fun fallback(drawable: Drawable?): ImageLoader.Builder

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

fun fallback(@DrawableRes() drawableResId: Int): ImageLoader.Builder

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

launchInterceptorChainOnMainThread

fun launchInterceptorChainOnMainThread(enable: Boolean): ImageLoader.Builder

Enables launching the Interceptor chain on the main thread.

logger

fun logger(logger: Logger?): ImageLoader.Builder

Set the Logger to write logs to.

memoryCache

fun memoryCache(memoryCache: MemoryCache): ImageLoader.Builder

Set the MemoryCache.

memoryCachePolicy

fun memoryCachePolicy(policy: CachePolicy): ImageLoader.Builder

Set the default memory cache policy.

networkCachePolicy

fun networkCachePolicy(policy: CachePolicy): ImageLoader.Builder

Set the default network cache policy.

networkObserverEnabled

fun networkObserverEnabled(enable: Boolean): ImageLoader.Builder

Enables short circuiting network requests if the device is offline.

okHttpClient

fun okHttpClient(initializer: () -> OkHttpClient): ImageLoader.Builder

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

fun okHttpClient(okHttpClient: OkHttpClient): ImageLoader.Builder

Set the OkHttpClient used for network requests.

placeholder

fun placeholder(drawable: Drawable?): ImageLoader.Builder

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

fun placeholder(@DrawableRes() drawableResId: Int): ImageLoader.Builder

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

precision

fun precision(precision: Precision): ImageLoader.Builder

Set the default precision for a request.

trackWeakReferences

fun trackWeakReferences(enable: Boolean): ImageLoader.Builder

Enables weak reference tracking of loaded images.

transition

@ExperimentalCoilApi()

fun transition(transition: Transition): ImageLoader.Builder

Set the default Transition for each request.