submitData

suspend fun submitData(pagingData: PagingData<T>, @LayoutRes id: Int, scope: ItemWrapper<T>.() -> Unit = {})

Present a PagingData until it is invalidated by a call to refresh or PagingSource.invalidate.

This method is typically used when collecting from a Flow produced by Pager. For RxJava or LiveData support, use the non-suspending overload of submitData, which accepts a Lifecycle.

Note: This method suspends while it is actively presenting page loads from a PagingData, until the PagingData is invalidated. Although cancellation will propagate to this call automatically, collecting from a Pager.flow with the intention of presenting the most up-to-date representation of your backing dataset should typically be done using collectLatest.

Since

1.2.0

See also


fun submitData(lifecycle: Lifecycle, pagingData: PagingData<T>, @LayoutRes id: Int, scope: ItemWrapper<T>.() -> Unit = {})

Present a PagingData until it is either invalidated or another call to submitData is made.

This method is typically used when observing a RxJava or LiveData stream produced by Pager. For Flow support, use the suspending overload of submitData, which automates cancellation via CoroutineScope instead of relying of Lifecycle.

Since

1.2.0

See also