HighlightAlbumParams.Builder

public final class HighlightAlbumParams.Builder

A builder for constructing HighlightAlbumParams instances.

Summary

Public constructors

Public methods
final @NonNull HighlightAlbumParams

Builds the HighlightAlbumParams object specified by this builder.
final @NonNull HighlightAlbumParams.Builder
setHighlightAlbum(@NonNull String highlightAlbum)

Sets the album to highlight.
final @NonNull HighlightAlbumParams.Builder
setHighlightType(int highlightType)

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

Public constructors

Builder

Added in 1.0.0-alpha03
public Builder()

Public methods

build

Added in 1.0.0-alpha03
public final @NonNull HighlightAlbumParams build()

Builds the HighlightAlbumParams object specified by this builder.

Returns
@NonNull HighlightAlbumParams

The newly constructed HighlightAlbumParams instance.
Throws
IllegalArgumentException

if highlightType or highlightAlbum is not set.

setHighlightAlbum

Added in 1.0.0-alpha03
public final @NonNull HighlightAlbumParams.Builder setHighlightAlbum(@NonNull String highlightAlbum)

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
@NonNull String highlightAlbum

A supported predefined album string constant.
Returns
@NonNull HighlightAlbumParams.Builder

This Builder.

setHighlightType

Added in 1.0.0-alpha03
public final @NonNull HighlightAlbumParams.Builder setHighlightType(int highlightType)

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

Parameters
int highlightType

A supported highlight type from HighlightType.
Returns
@NonNull HighlightAlbumParams.Builder

This Builder.