CombinedLoadStates
-
Cmn
class CombinedLoadStates
Collection of pagination LoadStates for both a PagingSource, and RemoteMediator.
Note: The REFRESHLoadType.REFRESH always has LoadState.endOfPaginationReached set to false.
Summary
Public constructors |
|
|---|---|
CombinedLoadStates( |
Cmn
|
Public properties |
||
|---|---|---|
LoadState |
Convenience for combined behavior of |
Cmn
|
Boolean |
Returns true if either |
Cmn
|
Boolean |
Returns true when |
Cmn
|
LoadStates? |
|
Cmn
|
LoadState |
Convenience for combined behavior of |
Cmn
|
LoadState |
Convenience for combined behavior of |
Cmn
|
LoadStates |
|
Cmn
|
Public constructors
CombinedLoadStates
CombinedLoadStates(
refresh: LoadState,
prepend: LoadState,
append: LoadState,
source: LoadStates,
mediator: LoadStates? = null
)
Public properties
append
val append: LoadState
Convenience for combined behavior of APPEND LoadState, which generally defers to mediator if it exists, but if previously was LoadState.Loading, awaits for both source and mediator to become LoadState.NotLoading to ensure the remote load was applied.
For use cases that require reacting to LoadState of source and mediator specifically, e.g., showing cached data when network loads via mediator fail, LoadStates exposed via source and mediator should be used directly.
hasError
val hasError: Boolean
Returns true if either source or mediator has a LoadType that is in LoadState.Error
mediator
val mediator: LoadStates?
LoadStates corresponding to loads from a RemoteMediator, or null if RemoteMediator not present.
prepend
val prepend: LoadState
Convenience for combined behavior of PREPEND LoadState, which generally defers to mediator if it exists, but if previously was LoadState.Loading, awaits for both source and mediator to become LoadState.NotLoading to ensure the remote load was applied.
For use cases that require reacting to LoadState of source and mediator specifically, e.g., showing cached data when network loads via mediator fail, LoadStates exposed via source and mediator should be used directly.
refresh
val refresh: LoadState
Convenience for combined behavior of REFRESH LoadState, which generally defers to mediator if it exists, but if previously was LoadState.Loading, awaits for both source and mediator to become LoadState.NotLoading to ensure the remote load was applied.
For use cases that require reacting to LoadState of source and mediator specifically, e.g., showing cached data when network loads via mediator fail, LoadStates exposed via source and mediator should be used directly.