Parameters

class Parameters : Iterable<Pair<String, Parameters.Entry>>

A map of generic values that can be used to pass custom data to Fetchers and Decoders.

Parameters are different from Tags as parameters are used to add extensions to ImageRequest whereas Tags are used for custom user metadata. Parameters also are not attached to any OkHttp Requests and also modify the request's memory cache key by default.

Constructors

Parameters
Link copied to clipboard
fun Parameters()

Types

Builder
Link copied to clipboard
class Builder
Companion
Link copied to clipboard
object Companion
Entry
Link copied to clipboard
class Entry(value: Any?, memoryCacheKey: String?)

Functions

entry
Link copied to clipboard
fun entry(key: String): Parameters.Entry?
Returns the entry associated with key or null if key has no mapping.
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
isEmpty
Link copied to clipboard
fun isEmpty(): Boolean
Returns 'true' if this object has no parameters.
iterator
Link copied to clipboard
open operator override fun iterator(): Iterator<Pair<String, Parameters.Entry>>
Returns an Iterator over the entries in the Parameters.
memoryCacheKey
Link copied to clipboard
fun memoryCacheKey(key: String): String?
Returns the cache key associated with key or null if key has no mapping.
memoryCacheKeys
Link copied to clipboard
fun memoryCacheKeys(): Map<String, String>
Returns a map of keys to non-null memory cache keys.
newBuilder
Link copied to clipboard
fun newBuilder(): Parameters.Builder
toString
Link copied to clipboard
open override fun toString(): String
value
Link copied to clipboard
fun <T : Any> value(key: String): T?
Returns the value associated with key or null if key has no mapping.
values
Link copied to clipboard
fun values(): Map<String, Any?>
Returns a map of keys to values.

Properties

size
Link copied to clipboard
val size: Int
Returns the number of parameters in this object.