Class GetSeveralAlbumsRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Album[], GetSeveralAlbumsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Album[], GetSeveralAlbumsRequest.Builder>

se.michaelthelin.spotify.requests.data.albums.GetSeveralAlbumsRequest.Builder

All Implemented Interfaces:

IRequest.Builder<Album[], GetSeveralAlbumsRequest.Builder>

Enclosing class:

GetSeveralAlbumsRequest

public static final class GetSeveralAlbumsRequest.Builder
extends AbstractDataRequest.Builder<Album[], GetSeveralAlbumsRequest.Builder>

Builder class for building a GetSeveralAlbumsRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetSeveralAlbumsRequest	build()	The request build method.
GetSeveralAlbumsRequest.Builder	ids(String ids)	The album IDs setter.
GetSeveralAlbumsRequest.Builder	market(CountryCode market)	The market query parameter setter.
protected GetSeveralAlbumsRequest.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
GetSeveralAlbumsRequest.Builder	setBody(org.apache.hc.core5.http.HttpEntity httpEntity)	Set the body for the request.
<X> GetSeveralAlbumsRequest.Builder	setBodyParameter(String name, X value)	Set a body parameter for the request.
GetSeveralAlbumsRequest.Builder	setContentType(org.apache.hc.core5.http.ContentType contentType)	Set the content type for the request.
GetSeveralAlbumsRequest.Builder	setDefaults(IHttpManager httpManager, String scheme, String host, Integer port)	Set default values for the request.
<X> GetSeveralAlbumsRequest.Builder	setHeader(String name, X value)	Set a header for the request.
GetSeveralAlbumsRequest.Builder	setHost(String host)	Set the host for the request.
GetSeveralAlbumsRequest.Builder	setHttpManager(IHttpManager httpManager)	Set the HTTP manager for the request.
GetSeveralAlbumsRequest.Builder	setPath(String path)	Set the path for the request.
GetSeveralAlbumsRequest.Builder	setPathParameter(String name, String value)	Set a path parameter for the request.
GetSeveralAlbumsRequest.Builder	setPort(Integer port)	Set the port for the request.
<X> GetSeveralAlbumsRequest.Builder	setQueryParameter(String name, X value)	Set a query parameter for the request.
GetSeveralAlbumsRequest.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 GetSeveralAlbumsRequest.Builder instance.

Parameters:

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

Method Details

ids

public GetSeveralAlbumsRequest.Builder ids(String ids)

The album IDs setter.

Parameters:

ids - Required. A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs.

Returns:

A GetSeveralAlbumsRequest.Builder.

See Also:

• Spotify: URIs & IDs

market

public GetSeveralAlbumsRequest.Builder market(CountryCode market)

The market query parameter setter.

Parameters:

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

Returns:

A GetSeveralAlbumsRequest.Builder.

See Also:

• Wikipedia: ISO 3166-1 alpha-2 country codes

build

public GetSeveralAlbumsRequest build()

The request build method.

Returns:

A custom GetSeveralAlbumsRequest.

self

protected GetSeveralAlbumsRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Album[], GetSeveralAlbumsRequest.Builder>

Returns:

This instance.