# HighlightSearchResultsParams

Artifact: [androidx.photopicker:photopicker-activity](https://developer.android.com/jetpack/androidx/releases/photopicker) [View Source](https://cs.android.com/search?q=file:androidx/photopicker/activity/params/HighlightSearchResultsParams.kt+class:androidx.photopicker.activity.params.HighlightSearchResultsParams) Added in [1.0.0-alpha03](https://developer.android.com/jetpack/androidx/releases/photopicker#1.0.0-alpha03)

*** ** * ** ***


```
class HighlightSearchResultsParams
```

<br />

*** ** * ** ***

Parameters for launching the photopicker with highlighted search results based on a text query.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightSearchResultsParams.Builder` A builder for constructing `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightSearchResultsParams` instances. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightSearchResultsParams#highlightSearchTextQuery()` The search query string used to highlight media results. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightSearchResultsParams#highlightType()` The requested `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightType.Companion.HighlightType` specifying how the highlighted search results are displayed. |

## Public properties

### highlightSearchTextQuery

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

```
val highlightSearchTextQuery: String
```

The search query string used to highlight media results.

### highlightType

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

```
val highlightType: Int
```

The requested `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightType.Companion.HighlightType` specifying how the highlighted search results are displayed.