LoadType


public enum LoadType extends Enum


Type of load a PagingData can trigger a PagingSource to perform.

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
LoadState

Summary

Enum Values

APPEND

Load at the end of a PagingData.

PREPEND

Load at the start of a PagingData.

REFRESH

PagingData content being refreshed, which can be a result of PagingSource invalidation, refresh that may contain content updates, or the initial load.

Public methods

final @NonNull EnumEntries<@NonNull LoadType>

Type of load a PagingData can trigger a PagingSource to perform.

final @NonNull LoadType

Returns the enum constant of this type with the specified name.

final @NonNull LoadType[]

Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

APPEND

LoadType LoadType.APPEND

Load at the end of a PagingData.

PREPEND

LoadType LoadType.PREPEND

Load at the start of a PagingData.

REFRESH

LoadType LoadType.REFRESH

PagingData content being refreshed, which can be a result of PagingSource invalidation, refresh that may contain content updates, or the initial load.

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull LoadTypegetEntries()

Type of load a PagingData can trigger a PagingSource to perform.

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
LoadState

valueOf

Added in 3.0.0
public final @NonNull LoadType valueOf(@NonNull String value)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

Added in 3.0.0
public final @NonNull LoadType[] values()

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.