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

Class TransferUsersPlaybackRequest.Builder

java.lang.Object

com.wrapper.spotify.requests.AbstractRequest.Builder<BuilderType>

com.wrapper.spotify.requests.data.AbstractDataRequest.Builder<TransferUsersPlaybackRequest.Builder>

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

All Implemented Interfaces:

IRequest.Builder

Enclosing class:

TransferUsersPlaybackRequest

public static final class TransferUsersPlaybackRequest.Builder
extends AbstractDataRequest.Builder<TransferUsersPlaybackRequest.Builder>

Builder class for building a TransferUsersPlaybackRequest.

Constructor Summary

Constructors

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

Method Summary

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

Builder

public Builder(String accessToken)

Create a new TransferUsersPlaybackRequest.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 Detail

device_ids

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

See Also:

Spotify: URIs & IDs

play

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

build

public TransferUsersPlaybackRequest build()

The request build method.

Returns:

A custom TransferUsersPlaybackRequest.