com.wrapper.spotify.requests.data.playlists

Class GetPlaylistsItemsRequest.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,GetPlaylistsItemsRequest.Builder>

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

All Implemented Interfaces:

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

Enclosing class:

GetPlaylistsItemsRequest

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

Builder class for building a GetPlaylistsItemsRequest.

Constructor Summary

Constructors

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

Method Summary

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

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 Detail

Builder

public Builder(String accessToken)

Create a new GetPlaylistsItemsRequest.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 Detail

user_id

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

See Also:

Spotify: URIs & IDs

playlist_id

public GetPlaylistsItemsRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

A GetPlaylistsItemsRequest.Builder.

See Also:

Spotify: URIs & IDs

fields

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

See Also:

Spotify: More Details on Playlist Fields

limit

public GetPlaylistsItemsRequest.Builder limit(Integer limit)

The limit setter.

Parameters:

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

Returns:

A GetPlaylistsItemsRequest.Builder.

offset

public GetPlaylistsItemsRequest.Builder offset(Integer offset)

The offset setter.

Parameters:

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

Returns:

A GetPlaylistsItemsRequest.Builder.

market

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

See Also:

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

additionalTypes

public GetPlaylistsItemsRequest.Builder additionalTypes(String additionalTypes)

The additional types setter.

Parameters:

additionalTypes - Optional. A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode. An unsupported type in the response is expected to be represented as null value in the item field.

Returns:

A GetPlaylistsItemsRequest.Builder.

build

public GetPlaylistsItemsRequest build()

The request build method.

Returns:

A custom GetPlaylistsItemsRequest.

self

protected GetPlaylistsItemsRequest.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>,GetPlaylistsItemsRequest.Builder>

Returns:

This instance.