avatarview-coil/io.getstream.avatarview.coil/Avatar

Avatar

data class Avatar(data: List<Any?>, maxSectionSize: Int, avatarBorderWidth: Int, errorPlaceholder: Drawable?, onSuccess: (request: ImageRequest, metadata: ImageResult.Metadata) -> Unit, onError: (request: ImageRequest, throwable: Throwable) -> Unit)

A data transfer model for transferring image data to AvatarFetcher. This model will be fetched by AvatarFetcher when we request image loading by using this type to Coil.

The default supported data types are:

String (mapped to a Uri)
Uri ("android.resource", "content", "file", "http", and "https" schemes only)
HttpUrl
File
DrawableRes
Drawable
Bitmap

Parameters

data

A list of image data.

maxSectionSize

The maximum section size of the avatar when loading multiple images.

avatarBorderWidth

The border width of AvatarView.

errorPlaceholder

An error placeholder that should be shown when request failed.

Constructors

Avatar

fun Avatar(data: List<Any?>, maxSectionSize: Int, avatarBorderWidth: Int, errorPlaceholder: Drawable?, onSuccess: (request: ImageRequest, metadata: ImageResult.Metadata) -> Unit, onError: (request: ImageRequest, throwable: Throwable) -> Unit)

Properties

avatarBorderWidth

val avatarBorderWidth: Int

The border width of AvatarView.

data

val data: List<Any?>

A list of data to be requested.

errorPlaceholder

val errorPlaceholder: Drawable?

An error placeholder that should be shown when request failed.

maxSectionSize

val maxSectionSize: Int

The maximum size of the sections.

onError

val onError: (request: ImageRequest, throwable: Throwable) -> Unit

A lambda function will be executed when loading failed.

onSuccess

val onSuccess: (request: ImageRequest, metadata: ImageResult.Metadata) -> Unit

A lambda function will be executed when loading succeeds.

Functions

getTag

fun <T : Any> getTag(key: String): T?

Returns the tag associated with this avatar using the given key.

setTagIfAbsent

fun <T : Any> setTagIfAbsent(key: String, newValue: T)

Sets a tag associated with this avatar and a key. If the given newValue was already set for the given key, this calls do nothing, the given newValue would be ignored.