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

Class GetEpisodeRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<T,BT>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Episode,GetEpisodeRequest.Builder>

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

All Implemented Interfaces:

IRequest.Builder<Episode,GetEpisodeRequest.Builder>

Enclosing class:

GetEpisodeRequest

public static final class GetEpisodeRequest.Builder
extends AbstractDataRequest.Builder<Episode,GetEpisodeRequest.Builder>

Builder class for building a GetEpisodeRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetEpisodeRequest	build()	The request build method.
GetEpisodeRequest.Builder	id(String id)	The episode ID setter.
GetEpisodeRequest.Builder	market(com.neovisionaries.i18n.CountryCode market)	The market country code setter.
protected GetEpisodeRequest.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 Detail

Builder

public Builder(String accessToken)

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

id

public GetEpisodeRequest.Builder id(String id)

The episode ID setter.

Parameters:

id - The Spotify ID for the episode.

Returns:

A GetEpisodeRequest.Builder.

See Also:

Spotify: URIs & IDs

market

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

See Also:

Wikipedia: ISO 3166-1 alpha-2 country codes

build

public GetEpisodeRequest build()

The request build method.

Returns:

A custom GetEpisodeRequest.

self

protected GetEpisodeRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Episode,GetEpisodeRequest.Builder>

Returns:

This instance.