HighlightAlbumParams.Builder

class HighlightAlbumParams.Builder

A builder for constructing HighlightAlbumParams instances.

Summary

Public constructors

Public functions
HighlightAlbumParams

Builds the HighlightAlbumParams object specified by this builder.
HighlightAlbumParams.Builder
setHighlightAlbum(highlightAlbum: String)

Sets the album to highlight.
HighlightAlbumParams.Builder
setHighlightType(highlightType: Int)

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

Public constructors

Builder

Added in 1.0.0-alpha03
Builder()

Public functions

build

Added in 1.0.0-alpha03
fun build(): HighlightAlbumParams

Builds the HighlightAlbumParams object specified by this builder.

Returns
HighlightAlbumParams

The newly constructed HighlightAlbumParams instance.
Throws
IllegalArgumentException

if highlightType or highlightAlbum is not set.

setHighlightAlbum

Added in 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: ALBUM_FAVORITES, ALBUM_CAMERA, ALBUM_DOWNLOADS, ALBUM_SCREENSHOTS, or ALBUM_VIDEOS.

Parameters
highlightAlbum: String

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
Returns
HighlightAlbumParams.Builder

This Builder.

setHighlightType

Added in 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: Int

A supported highlight type from HighlightType.

Value is one of the following:

  • 0
  • 1
Returns
HighlightAlbumParams.Builder

This Builder.