LoadState

Artifact: androidx.paging:paging-common

View Source

Added in 3.0.0

---

Kotlin |Java

Common/AllAndroid/JVM

• Cmn

  sealed class LoadState

Known direct subclasses

LoadState.Error, LoadState.Loading, LoadState.NotLoading

LoadState.Error	Loading hit an error.
LoadState.Loading	Loading is in progress.
LoadState.NotLoading	Indicates the PagingData is not currently loading, and no error currently observed.

---

LoadState of a PagedList load - associated with a LoadType

LoadState of any LoadType may be observed for UI purposes by registering a listener via androidx.paging.PagingDataAdapter.addLoadStateListener or androidx.paging.AsyncPagingDataDiffer.addLoadStateListener

See also
LoadType

Summary

Nested types
class LoadState.Error : LoadState Loading hit an error.
object LoadState.Loading : LoadState Loading is in progress.
class LoadState.NotLoading : LoadState Indicates the PagingData is not currently loading, and no error currently observed.

Protected constructors
LoadState(endOfPaginationReached: Boolean)	Cmn

Public properties
Boolean	endOfPaginationReached false if there is more data to load in the LoadType this LoadState is associated with, true otherwise.	Cmn

Protected constructors

LoadState

Cmn

protected LoadState(endOfPaginationReached: Boolean)

Parameters
endOfPaginationReached: Boolean	false if there is more data to load in the LoadType this LoadState is associated with, true otherwise. This parameter informs Pager if it should continue to make requests for additional data in this direction or if it should halt as the end of the dataset has been reached. Note: The REFRESHLoadType.REFRESH always has LoadState.endOfPaginationReached set to false.

Public properties

endOfPaginationReached

Cmn

Added in 3.0.0

val endOfPaginationReached: Boolean

false if there is more data to load in the LoadType this LoadState is associated with, true otherwise. This parameter informs Pager if it should continue to make requests for additional data in this direction or if it should halt as the end of the dataset has been reached.

Note: The REFRESHLoadType.REFRESH always has LoadState.endOfPaginationReached set to false.