Class TransferPlaybackRequest.Builder

java.lang.Object

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

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

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

All Implemented Interfaces:

IRequest.Builder<String, TransferPlaybackRequest.Builder>

Enclosing class:

TransferPlaybackRequest

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

Builder class for building a TransferPlaybackRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TransferPlaybackRequest	build()	The request build method.
TransferPlaybackRequest.Builder	device_ids(com.google.gson.JsonArray device_ids)	The device ID setter.
TransferPlaybackRequest.Builder	play(Boolean play)	The playing state setter.
protected TransferPlaybackRequest.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

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

device_ids

public TransferPlaybackRequest.Builder device_ids(com.google.gson.JsonArray device_ids)

The device ID setter.

Parameters:

device_ids - Required. A JSON array containing the ID of the device on which playback should be started/transferred. Note: Although an array is accepted, only a single device_id is currently supported.

Returns:

A TransferPlaybackRequest.Builder.

See Also:

• Spotify: URIs & IDs

play

public TransferPlaybackRequest.Builder play(Boolean play)

The playing state setter.

Parameters:

play - Optional. true: ensure playback happens on new device. false or not provided: keep the current playback state.

Returns:

A TransferPlaybackRequest.Builder.

build

public TransferPlaybackRequest build()

The request build method.

Returns:

A custom TransferPlaybackRequest.

self

protected TransferPlaybackRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.