Package se.michaelthelin.spotify.requests.data.episodes

Class GetSeveralEpisodesRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Episode[],GetSeveralEpisodesRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Episode[],GetSeveralEpisodesRequest.Builder>

se.michaelthelin.spotify.requests.data.episodes.GetSeveralEpisodesRequest.Builder

All Implemented Interfaces:

IRequest.Builder<Episode[],GetSeveralEpisodesRequest.Builder>

Enclosing class:

GetSeveralEpisodesRequest

public static final class GetSeveralEpisodesRequest.Builder
extends AbstractDataRequest.Builder<Episode[],GetSeveralEpisodesRequest.Builder>

Builder class for building a GetSeveralEpisodesRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetSeveralEpisodesRequest	build()	The request build method.
GetSeveralEpisodesRequest.Builder	ids(String ids)	The episode IDs setter.
GetSeveralEpisodesRequest.Builder	market(com.neovisionaries.i18n.CountryCode market)	The market country code setter.
protected GetSeveralEpisodesRequest.Builder	self()	Return this instance to simulate a self-type.

Methods inherited from class se.michaelthelin.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 GetSeveralEpisodesRequest.Builder.

Reading the user’s resume points on episode objects requires the user-read-playback-position scope.

Parameters:

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

Method Details

ids

public GetSeveralEpisodesRequest.Builder ids(String ids)

The episode IDs setter.

Parameters:

ids - Required. A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs.

Returns:

A GetSeveralEpisodesRequest.Builder.

See Also:

• Spotify: URIs & IDs

market

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

The market country code setter.

If a country code is specified, only shows and episodes that are available in that market will be returned. If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter. Note: If neither market or user country are provided, the content is considered unavailable for the client.

Users can view the country that is associated with their account in the account settings.

Parameters:

market - Optional. An ISO 3166-1 alpha-2 country code.

Returns:

A GetSeveralEpisodesRequest.Builder.

See Also:

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

build

public GetSeveralEpisodesRequest build()

The request build method.

Returns:

A custom GetSeveralEpisodesRequest.

self

protected GetSeveralEpisodesRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Episode[],GetSeveralEpisodesRequest.Builder>

Returns:

This instance.