com.wrapper.spotify.requests.data.playlists

Class CreatePlaylistRequest.Builder

java.lang.Object

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

com.wrapper.spotify.requests.data.AbstractDataRequest.Builder<Playlist,CreatePlaylistRequest.Builder>

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

All Implemented Interfaces:

IRequest.Builder<Playlist,CreatePlaylistRequest.Builder>

Enclosing class:

CreatePlaylistRequest

public static final class CreatePlaylistRequest.Builder
extends AbstractDataRequest.Builder<Playlist,CreatePlaylistRequest.Builder>

Builder class for building a CreatePlaylistRequest.

Constructor Summary

Constructors

Constructor and Description
Builder(String accessToken) Create a new CreatePlaylistRequest.Builder.

Method Summary

Modifier and Type	Method and Description
CreatePlaylistRequest	build() the request build method.
CreatePlaylistRequest.Builder	collaborative(Boolean collaborative) The collaborative state setter.
CreatePlaylistRequest.Builder	description(String description) The playlist description setter.
CreatePlaylistRequest.Builder	name(String name) The playlist name setter.
CreatePlaylistRequest.Builder	public_(Boolean public_) The public status setter.
protected CreatePlaylistRequest.Builder	self() Return this instance to simulate a self-type.
CreatePlaylistRequest.Builder	user_id(String user_id) The user ID setter.

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 Detail

Builder

public Builder(String accessToken)

Create a new CreatePlaylistRequest.Builder.

Creating a public playlists requires authorization of the playlist-modify-public scope; Creating a private playlist requires the playlist-modify-private scope.

Parameters:

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

See Also:

Spotify: Using Scopes

Method Detail

user_id

public CreatePlaylistRequest.Builder user_id(String user_id)

The user ID setter.

Parameters:

user_id - The user's Spotify user ID.

Returns:

A CreatePlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

name

public CreatePlaylistRequest.Builder name(String name)

The playlist name setter.

Parameters:

name - Optional. The name for the playlist. This name does not need to be unique; a user may have several playlists with the same name.

Returns:

A CreatePlaylistRequest.Builder.

public_

public CreatePlaylistRequest.Builder public_(Boolean public_)

The public status setter.

Note: To be able to create private playlists, the user must have granted the playlist-modify-private scope.

Parameters:

public_ - Optional. If true the playlist will be public, if false it will be private.

Returns:

A CreatePlaylistRequest.Builder.

collaborative

public CreatePlaylistRequest.Builder collaborative(Boolean collaborative)

The collaborative state setter.

Parameters:

collaborative - Optional, default false. If true the playlist will be collaborative. Note: To create a collaborative playlist you must also set public_(Boolean) to false. To create collaborative playlists you must have granted playlist-modify-private and playlist-modify-public scopes.

Returns:

A CreatePlaylistRequest.Builder.

description

public CreatePlaylistRequest.Builder description(String description)

The playlist description setter.

Parameters:

description - Optional, value for playlist description as displayed in Spotify Clients and in the Web API.

Returns:

A CreatePlaylistRequest.Builder.

build

public CreatePlaylistRequest build()

the request build method.

Returns:

A custom CreatePlaylistRequest.

self

protected CreatePlaylistRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Playlist,CreatePlaylistRequest.Builder>

Returns:

This instance.