Class GetUsersSavedAlbumsRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Paging<SavedAlbum>, GetUsersSavedAlbumsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<SavedAlbum>, GetUsersSavedAlbumsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<SavedAlbum, GetUsersSavedAlbumsRequest.Builder>

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

All Implemented Interfaces:

IPagingRequestBuilder<SavedAlbum, GetUsersSavedAlbumsRequest.Builder>, IRequest.Builder<Paging<SavedAlbum>, GetUsersSavedAlbumsRequest.Builder>

Enclosing class:

GetUsersSavedAlbumsRequest

public static final class GetUsersSavedAlbumsRequest.Builder
extends AbstractDataPagingRequest.Builder<SavedAlbum, GetUsersSavedAlbumsRequest.Builder>

Builder class for building a GetUsersSavedAlbumsRequest.

Constructor Summary

Constructors

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

Method Summary

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

The user-library-read scope must have been authorized by the user.

Parameters:

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

See Also:

• Spotify: Using Scopes

Method Details

limit

public GetUsersSavedAlbumsRequest.Builder limit(Integer limit)

The limit setter.

Parameters:

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

Returns:

A GetUsersSavedAlbumsRequest.Builder.

offset

public GetUsersSavedAlbumsRequest.Builder offset(Integer offset)

The offset setter.

Parameters:

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

Returns:

A GetUsersSavedAlbumsRequest.Builder.

market

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

See Also:

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

build

public GetUsersSavedAlbumsRequest build()

The request build method.

Returns:

A custom GetUsersSavedAlbumsRequest.

self

protected GetUsersSavedAlbumsRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Paging<SavedAlbum>, GetUsersSavedAlbumsRequest.Builder>

Returns:

This instance.