Class GetAudiobookChaptersRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Paging<ChapterSimplified>, GetAudiobookChaptersRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<ChapterSimplified>, GetAudiobookChaptersRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<ChapterSimplified, GetAudiobookChaptersRequest.Builder>

se.michaelthelin.spotify.requests.data.audiobooks.GetAudiobookChaptersRequest.Builder

All Implemented Interfaces:

IPagingRequestBuilder<ChapterSimplified, GetAudiobookChaptersRequest.Builder>, IRequest.Builder<Paging<ChapterSimplified>, GetAudiobookChaptersRequest.Builder>

Enclosing class:

GetAudiobookChaptersRequest

public static final class GetAudiobookChaptersRequest.Builder
extends AbstractDataPagingRequest.Builder<ChapterSimplified, GetAudiobookChaptersRequest.Builder>

Builder class for building a GetAudiobookChaptersRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetAudiobookChaptersRequest	build()	The request build method.
GetAudiobookChaptersRequest.Builder	id(String id)	The ID path parameter setter.
GetAudiobookChaptersRequest.Builder	limit(Integer limit)	The limit query parameter setter.
GetAudiobookChaptersRequest.Builder	market(CountryCode market)	The market query parameter setter.
GetAudiobookChaptersRequest.Builder	offset(Integer offset)	The offset query parameter setter.
protected GetAudiobookChaptersRequest.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 GetAudiobookChaptersRequest.Builder instance.

Parameters:

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

Method Details

id

public GetAudiobookChaptersRequest.Builder id(String id)

The ID path parameter setter.

Parameters:

id - The Spotify ID for the audiobook.

Returns:

A GetAudiobookChaptersRequest.Builder.

See Also:

• Spotify: URIs & IDs

limit

public GetAudiobookChaptersRequest.Builder limit(Integer limit)

The limit query parameter setter.

Parameters:

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

Returns:

A GetAudiobookChaptersRequest.Builder.

offset

public GetAudiobookChaptersRequest.Builder offset(Integer offset)

The offset query parameter setter.

Parameters:

offset - Optional. The index of the first chapter to return. Default: 0 (the first object).

Returns:

A GetAudiobookChaptersRequest.Builder.

market

public GetAudiobookChaptersRequest.Builder market(CountryCode market)

The market query parameter setter.

Parameters:

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

Returns:

A GetAudiobookChaptersRequest.Builder.

See Also:

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

build

public GetAudiobookChaptersRequest build()

The request build method.

Returns:

A custom GetAudiobookChaptersRequest.

self

protected GetAudiobookChaptersRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Paging<ChapterSimplified>, GetAudiobookChaptersRequest.Builder>

Returns:

This instance.