LoadStates

Artifact: androidx.paging:paging-common

View Source

Added in 3.0.0

---

Kotlin |Java

Common/AllAndroid/JVM

• Cmn

  data class LoadStates

---

Collection of pagination LoadStates - refresh, prepend, and append.

Summary

Public constructors
LoadStates(refresh: LoadState, prepend: LoadState, append: LoadState)	Cmn

Public properties
LoadState	append LoadState corresponding to LoadType.APPEND loads.	Cmn
Boolean	hasError Returns true if either one of refresh, append, or prepend is in Error state.	Cmn
Boolean	isIdle Returns true if all three LoadState refresh, append, and prepend are in NotLoading state.	Cmn
LoadState	prepend LoadState corresponding to LoadType.PREPEND loads.	Cmn
LoadState	refresh LoadState corresponding to LoadType.REFRESH loads.	Cmn

Public constructors

LoadStates

Cmn

Added in 3.0.0

LoadStates(refresh: LoadState, prepend: LoadState, append: LoadState)

Public properties

append

Cmn

Added in 3.0.0

val append: LoadState

LoadState corresponding to LoadType.APPEND loads.

hasError

Cmn

Added in 3.3.1

val hasError: Boolean

Returns true if either one of refresh, append, or prepend is in Error state.

isIdle

Cmn

Added in 3.3.1

val isIdle: Boolean

Returns true if all three LoadState refresh, append, and prepend are in NotLoading state.

prepend

Cmn

Added in 3.0.0

val prepend: LoadState

LoadState corresponding to LoadType.PREPEND loads.

refresh

Cmn

Added in 3.0.0

val refresh: LoadState

LoadState corresponding to LoadType.REFRESH loads.