Package com.wrapper.spotify.requests.data.player

Class ToggleShuffleForUsersPlaybackRequest.Builder

java.lang.Object

com.wrapper.spotify.requests.AbstractRequest.Builder<T,BT>

com.wrapper.spotify.requests.data.AbstractDataRequest.Builder<String,ToggleShuffleForUsersPlaybackRequest.Builder>

com.wrapper.spotify.requests.data.player.ToggleShuffleForUsersPlaybackRequest.Builder

All Implemented Interfaces:

IRequest.Builder<String,ToggleShuffleForUsersPlaybackRequest.Builder>

Enclosing class:

ToggleShuffleForUsersPlaybackRequest

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

Builder class for building a ToggleShuffleForUsersPlaybackRequest.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class com.wrapper.spotify.requests.AbstractRequest.Builder

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder(String accessToken)

Create a new ToggleShuffleForUsersPlaybackRequest.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 ToggleShuffleForUsersPlaybackRequest.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 ToggleShuffleForUsersPlaybackRequest.Builder.

device_id

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

See Also:

Spotify: URIs & IDs

build

public ToggleShuffleForUsersPlaybackRequest build()

The request build method.

Returns:

A custom ToggleShuffleForUsersPlaybackRequest.

self

protected ToggleShuffleForUsersPlaybackRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.