Class GetPlaybackStateRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<CurrentlyPlayingContext, GetPlaybackStateRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<CurrentlyPlayingContext, GetPlaybackStateRequest.Builder>

se.michaelthelin.spotify.requests.data.player.GetPlaybackStateRequest.Builder

All Implemented Interfaces:

IRequest.Builder<CurrentlyPlayingContext, GetPlaybackStateRequest.Builder>

Enclosing class:

GetPlaybackStateRequest

public static final class GetPlaybackStateRequest.Builder
extends AbstractDataRequest.Builder<CurrentlyPlayingContext, GetPlaybackStateRequest.Builder>

Builder class for building a GetPlaybackStateRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetPlaybackStateRequest.Builder	additionalTypes(String additionalTypes)	The additional types setter.
GetPlaybackStateRequest	build()	The request build method.
GetPlaybackStateRequest.Builder	market(CountryCode market)	The market country code setter.
protected GetPlaybackStateRequest.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

Constructor Details

Builder

public Builder(String accessToken)

Create a new GetPlaybackStateRequest.Builder.

Your access token must have the user-read-playback-state scope authorized in order to read information.

Parameters:

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

See Also:

• Spotify: Using Scopes

Method Details

market

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

See Also:

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

additionalTypes

public GetPlaybackStateRequest.Builder additionalTypes(String additionalTypes)

The additional types setter.

Parameters:

additionalTypes - Optional. A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode. An unsupported type in the response is expected to be represented as null value in the item field.

Returns:

A GetPlaybackStateRequest.Builder.

build

public GetPlaybackStateRequest build()

The request build method.

Returns:

A custom GetPlaybackStateRequest.

self

protected GetPlaybackStateRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<CurrentlyPlayingContext, GetPlaybackStateRequest.Builder>

Returns:

This instance.