Class GetUsersSavedEpisodesRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Paging<SavedEpisode>, GetUsersSavedEpisodesRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<SavedEpisode>, GetUsersSavedEpisodesRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<SavedEpisode, GetUsersSavedEpisodesRequest.Builder>

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

All Implemented Interfaces:

IPagingRequestBuilder<SavedEpisode, GetUsersSavedEpisodesRequest.Builder>, IRequest.Builder<Paging<SavedEpisode>, GetUsersSavedEpisodesRequest.Builder>

Enclosing class:

GetUsersSavedEpisodesRequest

public static final class GetUsersSavedEpisodesRequest.Builder
extends AbstractDataPagingRequest.Builder<SavedEpisode, GetUsersSavedEpisodesRequest.Builder>

Builder class for building a GetUsersSavedEpisodesRequest.

Constructor Summary

Constructors

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

Method Summary

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

The user-library-read scope must have been authorized by the user. Additionally, if the user has also authorized the user-read-playback-position scope, ResumePoint gets set.

Parameters:

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

See Also:

• Spotify: Scopes

Method Details

limit

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

offset

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

market

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

See Also:

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

build

public GetUsersSavedEpisodesRequest build()

The request build method.

Returns:

A custom GetUsersSavedEpisodesRequest.

self

protected GetUsersSavedEpisodesRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Paging<SavedEpisode>, GetUsersSavedEpisodesRequest.Builder>

Returns:

This instance.