# 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)

*** ** * ** ***


```
public final class HighlightSearchResultsParams
```

<br />

*** ** * ** ***

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

## Summary

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

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/photopicker/activity/params/HighlightSearchResultsParams#getHighlightSearchTextQuery()()` The search query string used to highlight media results. |
| `final int` | `https://developer.android.com/reference/androidx/photopicker/activity/params/HighlightSearchResultsParams#getHighlightType()()` The requested `https://developer.android.com/reference/androidx/photopicker/activity/params/HighlightType.Companion.HighlightType` specifying how the highlighted search results are displayed. |

## Public methods

### getHighlightSearchTextQuery

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

```
public final @NonNull String getHighlightSearchTextQuery()
```

The search query string used to highlight media results.

### getHighlightType

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

```
public final int getHighlightType()
```

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

Value is one of the following:

- `0`
- `1`

<br />