Class GetPlaylistItemsRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Paging<PlaylistTrack>, GetPlaylistItemsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<PlaylistTrack>, GetPlaylistItemsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<PlaylistTrack, GetPlaylistItemsRequest.Builder>

se.michaelthelin.spotify.requests.data.playlists.GetPlaylistItemsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetPlaylistItemsRequest

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

Builder class for building a GetPlaylistItemsRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetPlaylistItemsRequest.Builder	additionalTypes(String additionalTypes)	The additional types setter.
GetPlaylistItemsRequest	build()	The request build method.
GetPlaylistItemsRequest.Builder	fields(String fields)	The fields filter setter.
GetPlaylistItemsRequest.Builder	limit(Integer limit)	The limit setter.
GetPlaylistItemsRequest.Builder	market(CountryCode market)	The market country code setter.
GetPlaylistItemsRequest.Builder	offset(Integer offset)	The offset setter.
GetPlaylistItemsRequest.Builder	playlist_id(String playlist_id)	The playlist ID setter.
protected GetPlaylistItemsRequest.Builder	self()	Return this instance to simulate a self-type.

Methods inherited from class AbstractRequest.Builder

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

Modifier and Type	Method	Description
GetPlaylistItemsRequest.Builder	setBody(org.apache.hc.core5.http.HttpEntity httpEntity)	Set the body for the request.
<X> GetPlaylistItemsRequest.Builder	setBodyParameter(String name, X value)	Set a body parameter for the request.
GetPlaylistItemsRequest.Builder	setContentType(org.apache.hc.core5.http.ContentType contentType)	Set the content type for the request.
GetPlaylistItemsRequest.Builder	setDefaults(IHttpManager httpManager, String scheme, String host, Integer port)	Set default values for the request.
<X> GetPlaylistItemsRequest.Builder	setHeader(String name, X value)	Set a header for the request.
GetPlaylistItemsRequest.Builder	setHost(String host)	Set the host for the request.
GetPlaylistItemsRequest.Builder	setHttpManager(IHttpManager httpManager)	Set the HTTP manager for the request.
GetPlaylistItemsRequest.Builder	setPath(String path)	Set the path for the request.
GetPlaylistItemsRequest.Builder	setPathParameter(String name, String value)	Set a path parameter for the request.
GetPlaylistItemsRequest.Builder	setPort(Integer port)	Set the port for the request.
<X> GetPlaylistItemsRequest.Builder	setQueryParameter(String name, X value)	Set a query parameter for the request.
GetPlaylistItemsRequest.Builder	setScheme(String scheme)	Set the scheme for the request.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder(String accessToken)

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

playlist_id

public GetPlaylistItemsRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

A GetPlaylistItemsRequest.Builder.

See Also:

• Spotify: URIs & IDs

fields

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

See Also:

• Spotify: More Details on Playlist Fields

limit

public GetPlaylistItemsRequest.Builder limit(Integer limit)

The limit setter.

Parameters:

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

Returns:

A GetPlaylistItemsRequest.Builder.

offset

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

market

public GetPlaylistItemsRequest.Builder market(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 GetPlaylistItemsRequest.Builder.

See Also:

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

additionalTypes

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

build

public GetPlaylistItemsRequest build()

The request build method.

Returns:

A custom GetPlaylistItemsRequest.

self

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

Returns:

This instance.