Options

class Options(val context: PlatformContext, val size: Size = Size.ORIGINAL, val scale: Scale = Scale.FIT, val allowInexactSize: Boolean = false, val diskCacheKey: String? = null, val fileSystem: FileSystem = defaultFileSystem(), val memoryCachePolicy: CachePolicy = CachePolicy.ENABLED, val diskCachePolicy: CachePolicy = CachePolicy.ENABLED, val networkCachePolicy: CachePolicy = CachePolicy.ENABLED, val extras: Extras = Extras.EMPTY)

A set of configuration options for fetching and decoding an image.

Fetchers and Decoders should respect these options as best as possible.

Constructors

Options

constructor(context: PlatformContext, size: Size = Size.ORIGINAL, scale: Scale = Scale.FIT, allowInexactSize: Boolean = false, diskCacheKey: String? = null, fileSystem: FileSystem = defaultFileSystem(), memoryCachePolicy: CachePolicy = CachePolicy.ENABLED, diskCachePolicy: CachePolicy = CachePolicy.ENABLED, networkCachePolicy: CachePolicy = CachePolicy.ENABLED, extras: Extras = Extras.EMPTY)

Properties

allowInexactSize

val allowInexactSize: Boolean = false

'true' if the output image does not need to fit/fill the target's dimensions exactly. For instance, if 'true' BitmapFactoryDecoder will not decode an image at a larger size than its source dimensions as an optimization.

context

val context: PlatformContext

The PlatformContext used to execute this request.

diskCacheKey

val diskCacheKey: String? = null

The cache key to use when persisting images to the disk cache or 'null' if the component can compute its own.

diskCachePolicy

val diskCachePolicy: CachePolicy

Determines if this request is allowed to read/write from/to disk.

extras

val extras: Extras

Extras that are used to configure/extend an image loader's base functionality.

fileSystem

val fileSystem: FileSystem

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

memoryCachePolicy

val memoryCachePolicy: CachePolicy

Determines if this request is allowed to read/write from/to memory.

networkCachePolicy

val networkCachePolicy: CachePolicy

Determines if this request is allowed to read from the network.

scale

val scale: Scale

The scaling algorithm for how to fit the source image's dimensions into the target's dimensions.

size

val size: Size

The requested output size for the image request.

Functions

copy

fun copy(context: PlatformContext = this.context, size: Size = this.size, scale: Scale = this.scale, allowInexactSize: Boolean = this.allowInexactSize, diskCacheKey: String? = this.diskCacheKey, fileSystem: FileSystem = this.fileSystem, memoryCachePolicy: CachePolicy = this.memoryCachePolicy, diskCachePolicy: CachePolicy = this.diskCachePolicy, networkCachePolicy: CachePolicy = this.networkCachePolicy, extras: Extras = this.extras): Options

getExtra

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