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

Class GetPlaylistsTracksRequest.Builder

java.lang.Object

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

com.wrapper.spotify.requests.data.AbstractDataRequest.Builder<Paging<T>,BT>

com.wrapper.spotify.requests.data.AbstractDataPagingRequest.Builder<PlaylistTrack,GetPlaylistsTracksRequest.Builder>

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

All Implemented Interfaces:

IPagingRequestBuilder<PlaylistTrack,GetPlaylistsTracksRequest.Builder>, IRequest.Builder<Paging<PlaylistTrack>,GetPlaylistsTracksRequest.Builder>

Enclosing class:

GetPlaylistsTracksRequest

public static final class GetPlaylistsTracksRequest.Builder
extends AbstractDataPagingRequest.Builder<PlaylistTrack,GetPlaylistsTracksRequest.Builder>

Builder class for building a GetPlaylistsTracksRequest.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from interface com.wrapper.spotify.requests.IRequest.Builder

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

Constructor Details

Builder

public Builder(String accessToken)

Create a new GetPlaylistsTracksRequest.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 GetPlaylistsTracksRequest.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 GetPlaylistsTracksRequest.Builder.

See Also:

Spotify: URIs & IDs

playlist_id

public GetPlaylistsTracksRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

A GetPlaylistsTracksRequest.Builder.

See Also:

Spotify: URIs & IDs

fields

public GetPlaylistsTracksRequest.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 GetPlaylistsTracksRequest.Builder.

See Also:

Spotify: More Details on Playlist Fields

limit

public GetPlaylistsTracksRequest.Builder limit(Integer limit)

The limit setter.

Parameters:

limit - Optional. The maximum number of tracks to return. Default: 100. Minimum: 1. Maximum: 100.

Returns:

A GetPlaylistsTracksRequest.Builder.

offset

public GetPlaylistsTracksRequest.Builder offset(Integer offset)

The offset setter.

Parameters:

offset - Optional. The index of the first track to return. Default: 0 (the first object).

Returns:

A GetPlaylistsTracksRequest.Builder.

market

public GetPlaylistsTracksRequest.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 GetPlaylistsTracksRequest.Builder.

See Also:

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

build

public GetPlaylistsTracksRequest build()

The request build method.

Returns:

A custom GetPlaylistsTracksRequest.

self

protected GetPlaylistsTracksRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Paging<PlaylistTrack>,GetPlaylistsTracksRequest.Builder>

Returns:

This instance.