# HighlightAlbumParams.Builder

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/HighlightAlbumParams.kt+class:androidx.photopicker.activity.params.HighlightAlbumParams.Builder) Added in [1.0.0-alpha03](https://developer.android.com/jetpack/androidx/releases/photopicker#1.0.0-alpha03)

*** ** * ** ***


```
class HighlightAlbumParams.Builder
```

<br />

*** ** * ** ***

A builder for constructing `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams` instances.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams.Builder#Builder()()` |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams.Builder#build()()` Builds the `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams` object specified by this builder. |
| `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams.Builder` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams.Builder#setHighlightAlbum(kotlin.String)(highlightAlbum: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Sets the album to highlight. |
| `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams.Builder` | `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams.Builder#setHighlightType(kotlin.Int)(highlightType: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Sets the requested highlight type specifying how the highlighted album will be displayed. |

## Public constructors

### Builder

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

```
Builder()
```

## Public functions

### build

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

```
fun build(): HighlightAlbumParams
```

Builds the `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams` object specified by this builder.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams` | The newly constructed `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams` instance. |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams.Builder#highlightType()` or `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams.Builder#highlightAlbum()` is not set. |

### setHighlightAlbum

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

```
fun setHighlightAlbum(highlightAlbum: String): HighlightAlbumParams.Builder
```

Sets the album to highlight. The value should be one of the predefined album constants: `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#ALBUM_FAVORITES()`, `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#ALBUM_CAMERA()`, `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#ALBUM_DOWNLOADS()`, `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#ALBUM_SCREENSHOTS()`, or `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams#ALBUM_VIDEOS()`.

| Parameters |
|---|---|
| `highlightAlbum: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | A supported predefined album string constant. Value is one of the following: - `androidx.activity.result.contract.album.FAVORITES` - `androidx.activity.result.contract.album.CAMERA` - `androidx.activity.result.contract.album.DOWNLOADS` - `androidx.activity.result.contract.album.SCREENSHOTS` - `androidx.activity.result.contract.album.VIDEOS` <br /> |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams.Builder` | This Builder. |

### setHighlightType

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

```
fun setHighlightType(highlightType: Int): HighlightAlbumParams.Builder
```

Sets the requested highlight type specifying how the highlighted album will be displayed.

| Parameters |
|---|---|
| `highlightType: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | A supported highlight type from `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightType.Companion.HighlightType`. Value is one of the following: - `0` - `1` <br /> |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/photopicker/activity/params/HighlightAlbumParams.Builder` | This Builder. |