Package coil.request

Types

CachePolicy
Link copied to clipboard
enum CachePolicy : Enum<CachePolicy>
Represents the read/write policy for a cache source.
DefaultRequestOptions
Link copied to clipboard
class DefaultRequestOptions(dispatcher: CoroutineDispatcher, transition: Transition, precision: Precision, bitmapConfig: Bitmap.Config, allowHardware: Boolean, allowRgb565: Boolean, placeholder: Drawable?, error: Drawable?, fallback: Drawable?, memoryCachePolicy: CachePolicy, diskCachePolicy: CachePolicy, networkCachePolicy: CachePolicy)
A set of default options that are used to fill in unset ImageRequest values.
DefinedRequestOptions
Link copied to clipboard
class DefinedRequestOptions(lifecycle: Lifecycle?, sizeResolver: SizeResolver?, scale: Scale?, dispatcher: CoroutineDispatcher?, transition: Transition?, precision: Precision?, bitmapConfig: Bitmap.Config?, allowHardware: Boolean?, allowRgb565: Boolean?, memoryCachePolicy: CachePolicy?, diskCachePolicy: CachePolicy?, networkCachePolicy: CachePolicy?)
Tracks which values have been set (instead of computed automatically using a default) when building an ImageRequest.
Disposable
Link copied to clipboard
interface Disposable
Represents the work of an executed ImageRequest.
ErrorResult
Link copied to clipboard
data class ErrorResult(drawable: Drawable?, request: ImageRequest, throwable: Throwable) : ImageResult
Indicates that an error occurred while executing the request.
ImageRequest
Link copied to clipboard
class ImageRequest
An immutable value object that represents a request for an image.
ImageResult
Link copied to clipboard
sealed class ImageResult
Represents the result of an image request.
NullRequestData
Link copied to clipboard
object NullRequestData
The value for ImageRequest.data if the request's data was not set or was set to null.
NullRequestDataException
Link copied to clipboard
class NullRequestDataException : RuntimeException
Exception thrown when an ImageRequest with empty/null data is executed by an ImageLoader.
Parameters
Link copied to clipboard
class Parameters : Iterable<Pair<String, Parameters.Entry>>
A map of generic values that can be used to pass custom data to Fetchers and Decoders.
SuccessResult
Link copied to clipboard
data class SuccessResult(drawable: Drawable, request: ImageRequest, metadata: ImageResult.Metadata) : ImageResult
Indicates that the request completed successfully.

Functions

count
Link copied to clipboard
inline fun Parameters.count(): Int
Returns the number of parameters in this object.
get
Link copied to clipboard
inline operator fun Parameters.get(key: String): Any?
Returns the value associated with key or null if key has no mapping.
isNotEmpty
Link copied to clipboard
inline fun Parameters.isNotEmpty(): Boolean
Return true when the set contains elements.