# HighlightAlbumParams

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

*** ** * ** ***


```
public final class HighlightAlbumParams
```

<br />

*** ** * ** ***

Parameters for launching the photopicker to highlight a specific album's media.

## Summary

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

| ### Constants |
|---|---|
| `static 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/HighlightAlbumParams#ALBUM_CAMERA()` Highlights media results from the Camera album. |
| `static 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/HighlightAlbumParams#ALBUM_DOWNLOADS()` Highlights media results from the Downloads album. |
| `static 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/HighlightAlbumParams#ALBUM_FAVORITES()` Highlights media results from the Favorites album. |
| `static 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/HighlightAlbumParams#ALBUM_SCREENSHOTS()` Highlights media results from the Screenshots album. |
| `static 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/HighlightAlbumParams#ALBUM_VIDEOS()` Highlights media results from the Videos album. |

| ### 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/HighlightAlbumParams#getHighlightAlbum()()` The requested predefined album to highlight. |
| `final int` | `https://developer.android.com/reference/androidx/photopicker/activity/params/HighlightAlbumParams#getHighlightType()()` The requested `https://developer.android.com/reference/androidx/photopicker/activity/params/HighlightType.Companion.HighlightType` specifying how the highlighted album is displayed. |

## Constants

### ALBUM_CAMERA

```
public static final @NonNull String ALBUM_CAMERA
```

Highlights media results from the Camera album.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/MediaStore.html#PICK_IMAGES_HIGHLIGHT_ALBUM_CAMERA` |   |

### ALBUM_DOWNLOADS

```
public static final @NonNull String ALBUM_DOWNLOADS
```

Highlights media results from the Downloads album.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/MediaStore.html#PICK_IMAGES_HIGHLIGHT_ALBUM_DOWNLOADS` |   |

### ALBUM_FAVORITES

```
public static final @NonNull String ALBUM_FAVORITES
```

Highlights media results from the Favorites album.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/MediaStore.html#PICK_IMAGES_HIGHLIGHT_ALBUM_FAVORITES` |   |

### ALBUM_SCREENSHOTS

```
public static final @NonNull String ALBUM_SCREENSHOTS
```

Highlights media results from the Screenshots album.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/MediaStore.html#PICK_IMAGES_HIGHLIGHT_ALBUM_SCREENSHOTS` |   |

### ALBUM_VIDEOS

```
public static final @NonNull String ALBUM_VIDEOS
```

Highlights media results from the Videos album.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/MediaStore.html#PICK_IMAGES_HIGHLIGHT_ALBUM_VIDEOS` |   |

## Public methods

### getHighlightAlbum

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

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

The requested predefined album to highlight.

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 />

### 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 album is displayed.

Value is one of the following:

- `0`
- `1`

<br />