# ContentPager.QueryRunner

# ContentPager.QueryRunner

Artifact:[androidx.contentpager:contentpager](https://developer.android.com/jetpack/androidx/releases/contentpager)  
[View Source](https://cs.android.com/search?q=file:androidx/contentpager/content/ContentPager.java+class:androidx.contentpager.content.ContentPager.QueryRunner)  
Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/contentpager#1.0.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/contentpager/content/ContentPager.QueryRunner "View this page in Java")

<br />

```
interface ContentPager.QueryRunner
```

<br />

Known direct subclasses  
[LoaderQueryRunner](https://developer.android.com/reference/kotlin/androidx/contentpager/content/LoaderQueryRunner)  

|---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [LoaderQueryRunner](https://developer.android.com/reference/kotlin/androidx/contentpager/content/LoaderQueryRunner) | A[ContentPager.QueryRunner](https://developer.android.com/reference/kotlin/androidx/contentpager/content/ContentPager.QueryRunner)that executes queries using a[LoaderManager](https://developer.android.com/reference/android/app/LoaderManager.html). |

*** ** * ** ***

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

## Summary

|                                                                                                               ### Nested types                                                                                                               |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `interface `[ContentPager.QueryRunner.Callback](https://developer.android.com/reference/kotlin/androidx/contentpager/content/ContentPager.QueryRunner.Callback) Callback that receives a cursor once a query as been executed on the Runner. |

|                                ### Public functions                                 |
|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)       | [cancel](https://developer.android.com/reference/kotlin/androidx/contentpager/content/ContentPager.QueryRunner#cancel(androidx.contentpager.content.Query))`(query: `[Query](https://developer.android.com/reference/kotlin/androidx/contentpager/content/Query)`)` Attempt to cancel a (presumably) running query.                                                                                                                                                                                                 |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isRunning](https://developer.android.com/reference/kotlin/androidx/contentpager/content/ContentPager.QueryRunner#isRunning(androidx.contentpager.content.Query))`(query: `[Query](https://developer.android.com/reference/kotlin/androidx/contentpager/content/Query)`)`                                                                                                                                                                                                                                           |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)       | [query](https://developer.android.com/reference/kotlin/androidx/contentpager/content/ContentPager.QueryRunner#query(androidx.contentpager.content.Query,androidx.contentpager.content.ContentPager.QueryRunner.Callback))`(query: `[Query](https://developer.android.com/reference/kotlin/androidx/contentpager/content/Query)`, callback: `[ContentPager.QueryRunner.Callback](https://developer.android.com/reference/kotlin/androidx/contentpager/content/ContentPager.QueryRunner.Callback)`)` Execute a query. |

## Public functions

### cancel

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/contentpager#1.0.0)  

```
fun cancel(query: Query): Unit
```

Attempt to cancel a (presumably) running query.  

|                                              Parameters                                              |
|------------------------------------------------------------------------------------------------------|------------------------|
| `query: `[Query](https://developer.android.com/reference/kotlin/androidx/contentpager/content/Query) | The query in question. |

### isRunning

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/contentpager#1.0.0)  

```
fun isRunning(query: Query): Boolean
```  

|                                              Parameters                                              |
|------------------------------------------------------------------------------------------------------|------------------------|
| `query: `[Query](https://developer.android.com/reference/kotlin/androidx/contentpager/content/Query) | The query in question. |

|                                       Returns                                       |
|-------------------------------------------------------------------------------------|---------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | true if the query is already running. |

### query

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/contentpager#1.0.0)  

```
fun query(query: Query, callback: ContentPager.QueryRunner.Callback): Unit
```

Execute a query.  

|                                                                           Parameters                                                                            |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| `query: `[Query](https://developer.android.com/reference/kotlin/androidx/contentpager/content/Query)                                                            | The query that will be run. This value should be handed back to the callback when ready to run in the background.                |
| `callback: `[ContentPager.QueryRunner.Callback](https://developer.android.com/reference/kotlin/androidx/contentpager/content/ContentPager.QueryRunner.Callback) | The callback that should be called to both execute the query (in the background) and to receive the results (in the foreground). |