ContentPager.QueryRunner

Artifact: androidx.contentpager:contentpager

View Source

Added in 1.0.0

---

Kotlin |Java

public interface ContentPager.QueryRunner

Known direct subclasses

LoaderQueryRunner

LoaderQueryRunner

A ContentPager.QueryRunner that executes queries using a LoaderManager.

---

Implementations of this interface provide the mechanism for execution of queries off the UI thread.

Summary

Nested types
public interface ContentPager.QueryRunner.Callback Callback that receives a cursor once a query as been executed on the Runner.

Public methods
abstract void	cancel(@NonNull Query query) Attempt to cancel a (presumably) running query.
abstract boolean	isRunning(@NonNull Query query)
abstract void	query(     @NonNull Query query,     @NonNull ContentPager.QueryRunner.Callback callback ) Execute a query.

Public methods

cancel

Added in 1.0.0

abstract void cancel(@NonNull Query query)

Attempt to cancel a (presumably) running query.

Parameters
@NonNull Query query	The query in question.

isRunning

Added in 1.0.0

abstract boolean isRunning(@NonNull Query query)

Parameters
@NonNull Query query	The query in question.

Returns
boolean	true if the query is already running.

query

Added in 1.0.0

abstract void query(
    @NonNull Query query,
    @NonNull ContentPager.QueryRunner.Callback callback
)

Execute a query.

Parameters
@NonNull Query query	The query that will be run. This value should be handed back to the callback when ready to run in the background.
@NonNull ContentPager.QueryRunner.Callback callback	The callback that should be called to both execute the query (in the background) and to receive the results (in the foreground).