Package se.michaelthelin.spotify.requests.data.follow

Class FollowArtistsOrUsersRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<T,BT>

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

se.michaelthelin.spotify.requests.data.follow.FollowArtistsOrUsersRequest.Builder

All Implemented Interfaces:

IRequest.Builder<String,FollowArtistsOrUsersRequest.Builder>

Enclosing class:

FollowArtistsOrUsersRequest

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

Builder class for building a FollowArtistsOrUsersRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FollowArtistsOrUsersRequest	build()	The request build method.
FollowArtistsOrUsersRequest.Builder	ids(com.google.gson.JsonArray ids)	The user or artist IDs setter.
FollowArtistsOrUsersRequest.Builder	ids(String ids)	The user or artist IDs setter.
protected FollowArtistsOrUsersRequest.Builder	self()	Return this instance to simulate a self-type.
FollowArtistsOrUsersRequest.Builder	type(ModelObjectType type)	The type 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 Detail

Builder

public Builder(String accessToken)

Create a new FollowArtistsOrUsersRequest.

Modifying the list of artists or users the current user follows requires authorization of the user-follow-modify scope.

Parameters:

accessToken - Required. A valid access token from the Spotify Accounts service.

See Also:

Spotify: Using Scopes

Method Detail

type

public FollowArtistsOrUsersRequest.Builder type(ModelObjectType type)

The type setter.

Parameters:

type - Required. The ID type: either artist or user.

Returns:

A FollowArtistsOrUsersRequest.Builder.

ids

public FollowArtistsOrUsersRequest.Builder ids(String ids)

The user or artist IDs setter.

Parameters:

ids - Optional. A comma-separated list of the artist or the user Spotify IDs. A maximum of 50 IDs can be sent in one request.

Returns:

A FollowArtistsOrUsersRequest.Builder.

See Also:

Spotify URIs & IDs

ids

public FollowArtistsOrUsersRequest.Builder ids(com.google.gson.JsonArray ids)

The user or artist IDs setter.

Parameters:

ids - Optional. A json array of the artist or the user Spotify IDs. A maximum of 50 IDs can be sent in one request.

Returns:

A FollowArtistsOrUsersRequest.Builder.

See Also:

Spotify URIs & IDs

build

public FollowArtistsOrUsersRequest build()

The request build method.

Returns:

A custom FollowArtistsOrUsersRequest.

self

protected FollowArtistsOrUsersRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.