Class TogglePlaybackShuffleRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<String, TogglePlaybackShuffleRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<String, TogglePlaybackShuffleRequest.Builder>

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

All Implemented Interfaces:

IRequest.Builder<String, TogglePlaybackShuffleRequest.Builder>

Enclosing class:

TogglePlaybackShuffleRequest

public static final class TogglePlaybackShuffleRequest.Builder
extends AbstractDataRequest.Builder<String, TogglePlaybackShuffleRequest.Builder>

Builder class for building a TogglePlaybackShuffleRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TogglePlaybackShuffleRequest	build()	The request build method.
TogglePlaybackShuffleRequest.Builder	device_id(String device_id)	The device ID setter.
protected TogglePlaybackShuffleRequest.Builder	self()	Return this instance to simulate a self-type.
TogglePlaybackShuffleRequest.Builder	state(Boolean state)	The toggle state setter.

Methods inherited from class AbstractRequest.Builder

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

Modifier and Type	Method	Description
TogglePlaybackShuffleRequest.Builder	setBody(org.apache.hc.core5.http.HttpEntity httpEntity)	Set the body for the request.
<X> TogglePlaybackShuffleRequest.Builder	setBodyParameter(String name, X value)	Set a body parameter for the request.
TogglePlaybackShuffleRequest.Builder	setContentType(org.apache.hc.core5.http.ContentType contentType)	Set the content type for the request.
TogglePlaybackShuffleRequest.Builder	setDefaults(IHttpManager httpManager, String scheme, String host, Integer port)	Set default values for the request.
<X> TogglePlaybackShuffleRequest.Builder	setHeader(String name, X value)	Set a header for the request.
TogglePlaybackShuffleRequest.Builder	setHost(String host)	Set the host for the request.
TogglePlaybackShuffleRequest.Builder	setHttpManager(IHttpManager httpManager)	Set the HTTP manager for the request.
TogglePlaybackShuffleRequest.Builder	setPath(String path)	Set the path for the request.
TogglePlaybackShuffleRequest.Builder	setPathParameter(String name, String value)	Set a path parameter for the request.
TogglePlaybackShuffleRequest.Builder	setPort(Integer port)	Set the port for the request.
<X> TogglePlaybackShuffleRequest.Builder	setQueryParameter(String name, X value)	Set a query parameter for the request.
TogglePlaybackShuffleRequest.Builder	setScheme(String scheme)	Set the scheme for the request.

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 TogglePlaybackShuffleRequest.Builder.

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

Parameters:

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

See Also:

• Spotify: Using Scopes

Method Details

state

public TogglePlaybackShuffleRequest.Builder state(Boolean state)

The toggle state setter.

Parameters:

state - Required. true: Shuffle user's playback. false: Do not shuffle user's playback.

Returns:

A TogglePlaybackShuffleRequest.Builder.

device_id

public TogglePlaybackShuffleRequest.Builder device_id(String device_id)

The device ID setter.

Parameters:

device_id - Optional. The ID of the device this command is targeting. If not supplied, the user's currently active device is the target.

Returns:

A TogglePlaybackShuffleRequest.Builder.

See Also:

• Spotify: URIs & IDs

build

public TogglePlaybackShuffleRequest build()

The request build method.

Returns:

A custom TogglePlaybackShuffleRequest.

self

protected TogglePlaybackShuffleRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<String, TogglePlaybackShuffleRequest.Builder>

Returns:

This instance.