Class SetPlaybackVolumeRequest.Builder

java.lang.Object

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

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

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

All Implemented Interfaces:

IRequest.Builder<String, SetPlaybackVolumeRequest.Builder>

Enclosing class:

SetPlaybackVolumeRequest

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

Builder class for building a SetPlaybackVolumeRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SetPlaybackVolumeRequest	build()	The build method.
SetPlaybackVolumeRequest.Builder	device_id(String device_id)	The device ID setter.
protected SetPlaybackVolumeRequest.Builder	self()	Return this instance to simulate a self-type.
SetPlaybackVolumeRequest.Builder	volume_percent(Integer volume_percent)	The volume percentage setter.

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 SetPlaybackVolumeRequest.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

volume_percent

public SetPlaybackVolumeRequest.Builder volume_percent(Integer volume_percent)

The volume percentage setter.

Parameters:

volume_percent - Required. The volume to set. Must be a value from 0 to 100 inclusive.

Returns:

A SetPlaybackVolumeRequest.Builder.

device_id

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

See Also:

• Spotify: URIs & IDs

build

public SetPlaybackVolumeRequest build()

The build method.

Returns:

A custom SetPlaybackVolumeRequest.

self

protected SetPlaybackVolumeRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.