PagingSource.LoadParams.Append

public final class PagingSource.LoadParams.Append<Key extends Object> extends PagingSource.LoadParams


Params to load a page of data from a PagingSource via PagingSource.load to be appended to the end of the list.

Summary

Public fields

@NonNull Key

Key for the page to be loaded.

final int

Requested number of items to load.

final boolean

From PagingConfig.enablePlaceholders, true if placeholders are enabled and the load request for this LoadParams should populate LoadResult.Page.itemsBefore and LoadResult.Page.itemsAfter if possible.

Public constructors

<Key extends Object> Append(
    @NonNull Key key,
    int loadSize,
    boolean placeholdersEnabled
)

Public fields

key

@NonNull
public @NonNull Key key

Key for the page to be loaded.

key can be null only if this LoadParams is Refresh, and either no initialKey is provided to the Pager or PagingSource.getRefreshKey from the previous PagingSource returns null.

The value of key is dependent on the type of LoadParams:

loadSize

@NonNull
public final int loadSize

Requested number of items to load.

Note: It is valid for PagingSource.load to return a LoadResult that has a different number of items than the requested load size.

placeholdersEnabled

@NonNull
public final boolean placeholdersEnabled

From PagingConfig.enablePlaceholders, true if placeholders are enabled and the load request for this LoadParams should populate LoadResult.Page.itemsBefore and LoadResult.Page.itemsAfter if possible.

Public constructors

Append

public final <Key extends Object> Append(
    @NonNull Key key,
    int loadSize,
    boolean placeholdersEnabled
)