Class GetShowEpisodesRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Paging<EpisodeSimplified>, GetShowEpisodesRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<EpisodeSimplified>, GetShowEpisodesRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<EpisodeSimplified, GetShowEpisodesRequest.Builder>

se.michaelthelin.spotify.requests.data.shows.GetShowEpisodesRequest.Builder

All Implemented Interfaces:

IPagingRequestBuilder<EpisodeSimplified, GetShowEpisodesRequest.Builder>, IRequest.Builder<Paging<EpisodeSimplified>, GetShowEpisodesRequest.Builder>

Enclosing class:

GetShowEpisodesRequest

public static final class GetShowEpisodesRequest.Builder
extends AbstractDataPagingRequest.Builder<EpisodeSimplified, GetShowEpisodesRequest.Builder>

Builder class for building a GetShowEpisodesRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetShowEpisodesRequest	build()	The request build method.
GetShowEpisodesRequest.Builder	id(String id)	The show ID setter.
GetShowEpisodesRequest.Builder	limit(Integer limit)	The limit setter.
GetShowEpisodesRequest.Builder	market(CountryCode market)	The market country code setter.
GetShowEpisodesRequest.Builder	offset(Integer offset)	The offset setter.
protected GetShowEpisodesRequest.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

Methods inherited from class Object

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

Methods inherited from interface IRequest.Builder

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

Constructor Details

Builder

public Builder(String accessToken)

Create a new GetShowEpisodesRequest.Builder instance.

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.

See Also:

• Spotify: Using Scopes

Method Details

id

public GetShowEpisodesRequest.Builder id(String id)

The show ID setter.

Parameters:

id - The Spotify ID for the show.

Returns:

A GetShowEpisodesRequest.Builder.

See Also:

• Spotify: URIs & IDs

limit

public GetShowEpisodesRequest.Builder limit(Integer limit)

The limit setter.

Parameters:

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

Returns:

A GetShowEpisodesRequest.Builder.

offset

public GetShowEpisodesRequest.Builder offset(Integer offset)

The offset setter.

Parameters:

offset - Optional. The index of the first episode to return. Default: 0 (i.e., the first object). Use with limit(Integer) to get the next set of objects.

Returns:

A GetShowEpisodesRequest.Builder.

market

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

See Also:

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

build

public GetShowEpisodesRequest build()

The request build method.

Returns:

A custom GetShowEpisodesRequest.

self

protected GetShowEpisodesRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Paging<EpisodeSimplified>, GetShowEpisodesRequest.Builder>

Returns:

This instance.