Package com.wrapper.spotify.requests.data.playlists

Class UploadCustomPlaylistCoverImageRequest.Builder

java.lang.Object

com.wrapper.spotify.requests.AbstractRequest.Builder<T,BT>

com.wrapper.spotify.requests.data.AbstractDataRequest.Builder<String,UploadCustomPlaylistCoverImageRequest.Builder>

com.wrapper.spotify.requests.data.playlists.UploadCustomPlaylistCoverImageRequest.Builder

All Implemented Interfaces:

IRequest.Builder<String,UploadCustomPlaylistCoverImageRequest.Builder>

Enclosing class:

UploadCustomPlaylistCoverImageRequest

public static final class UploadCustomPlaylistCoverImageRequest.Builder
extends AbstractDataRequest.Builder<String,UploadCustomPlaylistCoverImageRequest.Builder>

Builder class for building an UploadCustomPlaylistCoverImageRequest.

Constructor Summary

Constructors

Constructor	Description
Builder(String accessToken)	Create a new UploadCustomPlaylistCoverImageRequest.Builder.

Method Summary

Modifier and Type	Method	Description
UploadCustomPlaylistCoverImageRequest	build()	The request build method.
UploadCustomPlaylistCoverImageRequest.Builder	image_data(String image_data)	The image data setter.
UploadCustomPlaylistCoverImageRequest.Builder	playlist_id(String playlist_id)	The playlist ID setter.
protected UploadCustomPlaylistCoverImageRequest.Builder	self()	Return this instance to simulate a self-type.
UploadCustomPlaylistCoverImageRequest.Builder	user_id(String user_id)	Deprecated. Playlist IDs are unique for themselves.

Methods inherited from class com.wrapper.spotify.requests.AbstractRequest.Builder

setBody, setBodyParameter, setContentType, setDefaults, setHeader, setHost, setHttpManager, setPath, setPathParameter, setPort, setQueryParameter, setScheme

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder(String accessToken)

Create a new UploadCustomPlaylistCoverImageRequest.Builder.

This access token must be tied to the user who owns the playlist, and must have the scope ugc-image-upload granted. In addition, the token must also contain playlist-modify-public and/or playlist-modify-private, depending the public status of the playlist you want to update.

Parameters:

accessToken - Required. A valid access token from the Spotify Accounts service.

See Also:

Spotify: Using Scopes

Method Details

user_id

@Deprecated public UploadCustomPlaylistCoverImageRequest.Builder user_id(String user_id)

Deprecated.

Playlist IDs are unique for themselves. This parameter is thus no longer used. (https://developer.spotify.com/community/news/2018/06/12/changes-to-playlist-uris/)

The user ID setter.

Parameters:

user_id - The user's Spotify user ID.

Returns:

A UploadCustomPlaylistCoverImageRequest.Builder.

See Also:

Spotify: URIs & IDs

playlist_id

public UploadCustomPlaylistCoverImageRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

A UploadCustomPlaylistCoverImageRequest.Builder.

See Also:

Spotify: URIs & IDs

image_data

public UploadCustomPlaylistCoverImageRequest.Builder image_data(String image_data)

The image data setter.

Parameters:

image_data - Base64 encoded JPEG image data, maximum payload size is 256 KB.

Returns:

A UploadCustomPlaylistCoverImageRequest.Builder.

build

public UploadCustomPlaylistCoverImageRequest build()

The request build method.

Returns:

A custom UploadCustomPlaylistCoverImageRequest.

self

protected UploadCustomPlaylistCoverImageRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<String,UploadCustomPlaylistCoverImageRequest.Builder>

Returns:

This instance.