com.wrapper.spotify.requests.data.follow

Class FollowPlaylistRequest.Builder

java.lang.Object

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

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

com.wrapper.spotify.requests.data.follow.FollowPlaylistRequest.Builder

All Implemented Interfaces:

IRequest.Builder<String,FollowPlaylistRequest.Builder>

Enclosing class:

FollowPlaylistRequest

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

Builder class for building a FollowPlaylistRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FollowPlaylistRequest	build() The request build method.
FollowPlaylistRequest.Builder	playlist_id(String playlist_id) The playlist ID setter.
FollowPlaylistRequest.Builder	public_(Boolean public_) The public following state setter.
protected FollowPlaylistRequest.Builder	self() Return this instance to simulate a self-type.

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 FollowPlaylistRequest instance.

Following a playlist publicly requires authorization of the playlist-modify-public scope; following it privately 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

playlist_id

public FollowPlaylistRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID of the playlist. Any playlist can be followed, regardless of its public/private status, as long as you know its playlist ID.

Returns:

A FollowPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

public_

public FollowPlaylistRequest.Builder public_(Boolean public_)

The public following state setter.

Parameters:

public_ - Optional, default true. If true the playlist will be included in user's public playlists, if false it will remain private. To be able to follow playlists privately, the user must have granted the playlist-modify-private scope.

Returns:

A FollowPlaylistRequest.Builder.

build

public FollowPlaylistRequest build()

The request build method.

Returns:

A custom FollowPlaylistRequest.

self

protected FollowPlaylistRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.