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

Class GetPlaylistRequest.Builder

java.lang.Object

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

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

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

All Implemented Interfaces:

IRequest.Builder<Playlist,GetPlaylistRequest.Builder>

Enclosing class:

GetPlaylistRequest

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

Builder class for building a GetPlaylistRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetPlaylistRequest	build()	The request build method.
GetPlaylistRequest.Builder	fields(String fields)	The fields filter setter.
GetPlaylistRequest.Builder	market(com.neovisionaries.i18n.CountryCode market)	The market country code setter.
GetPlaylistRequest.Builder	playlist_id(String playlist_id)	The playlist ID setter.
protected GetPlaylistRequest.Builder	self()	Return this instance to simulate a self-type.
GetPlaylistRequest.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 GetPlaylistRequest.Builder.

Both Public and Private playlists belonging to any user are retrievable on provision of a valid access token.

Parameters:

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

Method Details

user_id

@Deprecated public GetPlaylistRequest.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 GetPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

playlist_id

public GetPlaylistRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

A GetPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

fields

public GetPlaylistRequest.Builder fields(String fields)

The fields filter setter.

Parameters:

fields - Optional. Filters for the query: a comma-separated list of the fields to return. If omitted, all fields are returned.

Returns:

A GetPlaylistRequest.Builder.

See Also:

Spotify: More Details on Playlist Fields

market

public GetPlaylistRequest.Builder market(com.neovisionaries.i18n.CountryCode market)

The market country code setter.

Parameters:

market - Optional. An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.

Returns:

A GetPlaylistRequest.Builder.

See Also:

Wikipedia: ISO 3166-1 alpha-2 country codes, Spotify: Track Relinking Guide

build

public GetPlaylistRequest build()

The request build method.

Returns:

A custom GetPlaylistRequest.

self

protected GetPlaylistRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.