Package se.michaelthelin.spotify.requests.data.player

Class StartResumeUsersPlaybackRequest.Builder

java.lang.Object

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

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

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

All Implemented Interfaces:

IRequest.Builder<String,StartResumeUsersPlaybackRequest.Builder>

Enclosing class:

StartResumeUsersPlaybackRequest

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

Builder class for building a StartResumeUsersPlaybackRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
StartResumeUsersPlaybackRequest	build()	The request build method.
StartResumeUsersPlaybackRequest.Builder	context_uri(String context_uri)	The context URI setter.
StartResumeUsersPlaybackRequest.Builder	device_id(String device_id)	The device ID setter.
StartResumeUsersPlaybackRequest.Builder	offset(com.google.gson.JsonObject offset)	The offset setter.
StartResumeUsersPlaybackRequest.Builder	position_ms(Integer position_ms)	The position setter.
protected StartResumeUsersPlaybackRequest.Builder	self()	Return this instance to simulate a self-type.
StartResumeUsersPlaybackRequest.Builder	uris(com.google.gson.JsonArray uris)	The URI setter.

Methods inherited from class se.michaelthelin.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 StartResumeUsersPlaybackRequest.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_id

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

See Also:

• Spotify: URIs & IDs

context_uri

public StartResumeUsersPlaybackRequest.Builder context_uri(String context_uri)

The context URI setter.

Parameters:

context_uri - Optional. Spotify URI of the context to play. Valid contexts are albums, artists and playlists.

Returns:

A StartResumeUsersPlaybackRequest.Builder.

See Also:

• Spotify: URIs & IDs

uris

public StartResumeUsersPlaybackRequest.Builder uris(com.google.gson.JsonArray uris)

The URI setter.

Parameters:

uris - Optional. A JSON array of the Spotify track URIs to play.

Returns:

A StartResumeUsersPlaybackRequest.Builder.

See Also:

• Spotify: URIs & IDs

offset

public StartResumeUsersPlaybackRequest.Builder offset(com.google.gson.JsonObject offset)

The offset setter.

Note: If context_uri(String) has been set and corresponds to an album or playlist object, an offset can be specified either by track uri OR position. If both are present the request will return an error. If incorrect values are provided for position or uri, the request may be accepted but with an unpredictable resulting action on playback.

Parameters:

offset - Optional. Indicates from where in the context playback should start. Only available when context_uri(String) corresponds to an album or playlist object, or when the uris(JsonArray) parameter is used.
The position parameter in the offset object is zero based and can’t be negative.
The uri parameter in the offset object is a string representing the URI of the item to start at.

Returns:

A StartResumeUsersPlaybackRequest.Builder.

position_ms

public StartResumeUsersPlaybackRequest.Builder position_ms(Integer position_ms)

The position setter.

Parameters:

position_ms - Optional. Indicates from what position to start playback. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.

Returns:

A StartResumeUsersPlaybackRequest.Builder.

build

public StartResumeUsersPlaybackRequest build()

The request build method.

Returns:

A custom StartResumeUsersPlaybackRequest.

self

protected StartResumeUsersPlaybackRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.