muzei-api / com.google.android.apps.muzei.api.provider / Artwork / Builder

Builder

class Builder

A builder-style, fluent interface for creating Artwork objects.

For example:

Artwork artwork = new Artwork.Builder()
  .persistentUri(Uri.parse("http://example.com/image.jpg"))
  .title("Example image")
  .byline("Unknown person, c. 1980")
  .attribution("Copyright (C) Unknown person, 1980")
  .build()

Constructors

<init>

A builder-style, fluent interface for creating Artwork objects.

Builder()

Functions

attribution

Sets the artwork's user-visible attribution text.

fun attribution(attribution: String?): Builder

build

Creates and returns the final Artwork object. Once this method is called, it is not valid to further use this Artwork.Builder object.

fun build(): Artwork

byline

Sets the artwork's user-visible byline, usually containing the author and date.

fun byline(byline: String?): Builder

metadata

Sets the provider specific metadata about the artwork.

fun metadata(metadata: String?): Builder

persistentUri

Sets the artwork's persistent URI, which must resolve to a JPEG or PNG image, ideally under 5MB.

fun persistentUri(persistentUri: Uri?): Builder

title

Sets the artwork's user-visible title.

fun title(title: String?): Builder

token

Sets the artwork's opaque application-specific identifier.

fun token(token: String?): Builder

webUri

Sets the artwork's web URI. This is used by default in MuzeiArtProvider.getArtworkInfo to allow the user to view more details about the artwork.

fun webUri(webUri: Uri?): Builder