CombinedLoadStates

Added in 3.0.0

Kotlin |Java

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( refresh: LoadState, prepend: LoadState, append: LoadState, source: LoadStates, mediator: LoadStates? )`	Cmn

Public functions
`open operator Boolean`	`equals(other: Any?)`	Cmn
`open Int`	`hashCode()`	Cmn
`open String`	`toString()`	Cmn

Public properties
`LoadState`	`append` 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.	Cmn
`Boolean`	`hasError` Returns true if either `source` or `mediator` has a `LoadType` that is in `LoadState.Error`	Cmn
`Boolean`	`isIdle` Returns true when `source` and `mediator` is in `NotLoading` for all `LoadType`	Cmn
`LoadStates?`	`mediator` `LoadStates` corresponding to loads from a `RemoteMediator`, or `null` if `RemoteMediator` not present.	Cmn
`LoadState`	`prepend` 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.	Cmn
`LoadState`	`refresh` 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.	Cmn
`LoadStates`	`source` `LoadStates` corresponding to loads from a `PagingSource`.	Cmn

Public constructors

CombinedLoadStates

Cmn

Added in 3.0.0

CombinedLoadStates(
    refresh: LoadState,
    prepend: LoadState,
    append: LoadState,
    source: LoadStates,
    mediator: LoadStates? = null
)

Public functions

equals

Cmn

open operator fun equals(other: Any?): Boolean

hashCode

Cmn

open fun hashCode(): Int

toString

Cmn

open fun toString(): String

Public properties

append

Cmn

Added in 3.0.0

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

Cmn

Added in 3.3.4

val hasError: Boolean

Returns true if either source or mediator has a LoadType that is in LoadState.Error

isIdle

Cmn

Added in 3.3.4

val isIdle: Boolean

Returns true when source and mediator is in NotLoading for all LoadType

mediator

Cmn

Added in 3.0.0

val mediator: LoadStates?

LoadStates corresponding to loads from a RemoteMediator, or null if RemoteMediator not present.

prepend

Cmn

Added in 3.0.0

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.

refresh

Cmn

Added in 3.0.0

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.

source

Cmn

Added in 3.0.0

val source: LoadStates

LoadStates corresponding to loads from a PagingSource.