com.wrapper.spotify

Class Api

java.lang.Object

com.wrapper.spotify.Api

public class Api
extends Object

Instances of the Api class provide access to the Spotify Web API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Api.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static Api	DEFAULT_API Api instance with the default settings.
static String	DEFAULT_AUTHENTICATION_HOST
static int	DEFAULT_AUTHENTICATION_PORT
static UtilProtos.Url.Scheme	DEFAULT_AUTHENTICATION_SCHEME
static String	DEFAULT_HOST The default host of Spotify API calls.
static HttpManager	DEFAULT_HTTP_MANAGER A HttpManager configured with default settings.
static int	DEFAULT_PORT The default port of Spotify API calls.
static UtilProtos.Url.Scheme	DEFAULT_SCHEME The default http scheme of Spotify API calls.

Method Summary

Methods

Modifier and Type	Method and Description
AddToMySavedTracksRequest.Builder	addToMySavedTracks(List<String> trackIds) Save tracks in the user's Your Music library.
AddTrackToPlaylistRequest.Builder	addTracksToPlaylist(String userId, String playlistId, List<String> trackUris) Add tracks to a playlist.
AuthorizationCodeGrantRequest.Builder	authorizationCodeGrant(String code) Returns a builder that can be used to build requests for authorization code grants.
static Api.Builder	builder()
ChangePlaylistDetailsRequest.Builder	changePlaylistDetails(String userId, String playlistId) Update a playlist's properties.
ClientCredentialsGrantRequest.Builder	clientCredentialsGrant() Returns a builder that can be used to build requests for client credential grants.
ContainsMySavedTracksRequest.Builder	containsMySavedTracks(List<String> trackIds) Check if a track is saved in the user's Your Music library.
AuthorizationURLRequest.Builder	createAuthorizeURL(List<String> scopes) Retrieve a URL where the user can give the application permissions.
String	createAuthorizeURL(List<String> scopes, String state) Retrieve a URL where the user can give the application permissions.
PlaylistCreationRequest.Builder	createPlaylist(String userId, String title) Create a playlist.
AlbumRequest.Builder	getAlbum(String id) Returns a an album with the id given below.
AlbumsRequest.Builder	getAlbums(List<String> ids)
AlbumsRequest.Builder	getAlbums(String... ids)
AlbumsForArtistRequest.Builder	getAlbumsForArtist(String artistId)
ArtistRequest.Builder	getArtist(String id)
RelatedArtistsRequest.Builder	getArtistRelatedArtists(String artistId) Get artists related/similar to an artist.
ArtistsRequest.Builder	getArtists(List<String> ids)
ArtistsRequest.Builder	getArtists(String... ids)
FeaturedPlaylistsRequest.Builder	getFeaturedPlaylists() Used to get Featured Playlists.
CurrentUserRequest.Builder	getMe() Get information about the user that has given authorization to the application.
GetMySavedTracksRequest.Builder	getMySavedTracks() Get a users Your Music tracks.
NewReleasesRequest.Builder	getNewReleases()
PlaylistRequest.Builder	getPlaylist(String userId, String playlistId) Get a playlist.
UserPlaylistsRequest.Builder	getPlaylistsForUser(String userId)
PlaylistTracksRequest.Builder	getPlaylistTracks(String userId, String playlistId) Get a playlist's tracks.
PlaylistTracksRequest.Builder	getStarred(String userId) Get a user's starred tracks.
TopTracksRequest.Builder	getTopTracksForArtist(String artistId, String countryCode)
TrackRequest.Builder	getTrack(String id)
TracksRequest.Builder	getTracks(List<String> ids)
TracksRequest.Builder	getTracks(String... ids)
UserRequest.Builder	getUser(String userId)
RefreshAccessTokenRequest.Builder	refreshAccessToken() Returns a builder that can be used to build requests to refresh an access token that has been retrieved using the authorization code grant flow.
RemoveFromMySavedTracksRequest.Builder	removeFromMySavedTracks(List<String> trackIds) Remove a track if saved to the user's Your Music library.
AlbumSearchRequest.Builder	searchAlbums(String query)
ArtistSearchRequest.Builder	searchArtists(String query)
TrackSearchRequest.Builder	searchTracks(String query)
void	setAccessToken(String accessToken)
void	setRefreshToken(String refreshToken)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

The default host of Spotify API calls.

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port of Spotify API calls.

See Also:

Constant Field Values

DEFAULT_HTTP_MANAGER

public static final HttpManager DEFAULT_HTTP_MANAGER

A HttpManager configured with default settings.

DEFAULT_SCHEME

public static final UtilProtos.Url.Scheme DEFAULT_SCHEME

The default http scheme of Spotify API calls.

DEFAULT_AUTHENTICATION_HOST

public static final String DEFAULT_AUTHENTICATION_HOST

See Also:

Constant Field Values

DEFAULT_AUTHENTICATION_PORT

public static final int DEFAULT_AUTHENTICATION_PORT

See Also:

Constant Field Values

DEFAULT_AUTHENTICATION_SCHEME

public static final UtilProtos.Url.Scheme DEFAULT_AUTHENTICATION_SCHEME

DEFAULT_API

public static final Api DEFAULT_API

Api instance with the default settings.

Method Detail

builder

public static Api.Builder builder()

getAlbum

public AlbumRequest.Builder getAlbum(String id)

Returns a an album with the id given below.

Parameters:

id - The base62 id of the album you're trying to retrieve.

Returns:

An {AlbumRequest.Builder} instance.

getAlbums

public AlbumsRequest.Builder getAlbums(String... ids)

getAlbums

public AlbumsRequest.Builder getAlbums(List<String> ids)

getAlbumsForArtist

public AlbumsForArtistRequest.Builder getAlbumsForArtist(String artistId)

getArtist

public ArtistRequest.Builder getArtist(String id)

getArtists

public ArtistsRequest.Builder getArtists(String... ids)

getArtists

public ArtistsRequest.Builder getArtists(List<String> ids)

getTrack

public TrackRequest.Builder getTrack(String id)

getTracks

public TracksRequest.Builder getTracks(String... ids)

getTracks

public TracksRequest.Builder getTracks(List<String> ids)

searchAlbums

public AlbumSearchRequest.Builder searchAlbums(String query)

searchTracks

public TrackSearchRequest.Builder searchTracks(String query)

searchArtists

public ArtistSearchRequest.Builder searchArtists(String query)

getNewReleases

public NewReleasesRequest.Builder getNewReleases()

getFeaturedPlaylists

public FeaturedPlaylistsRequest.Builder getFeaturedPlaylists()

Used to get Featured Playlists.

Returns:

A builder that can be used to build requests to get featured playlists.

getTopTracksForArtist

public TopTracksRequest.Builder getTopTracksForArtist(String artistId,
                                             String countryCode)

getUser

public UserRequest.Builder getUser(String userId)

getPlaylistsForUser

public UserPlaylistsRequest.Builder getPlaylistsForUser(String userId)

authorizationCodeGrant

public AuthorizationCodeGrantRequest.Builder authorizationCodeGrant(String code)

Returns a builder that can be used to build requests for authorization code grants. Requires client ID, client secret, and redirect URI to be set.

Parameters:

code - An authorization code.

Returns:

A builder that builds authorization code grant requests.

refreshAccessToken

public RefreshAccessTokenRequest.Builder refreshAccessToken()

Returns a builder that can be used to build requests to refresh an access token that has been retrieved using the authorization code grant flow.

Returns:

A builder that builds refresh access token requests.

clientCredentialsGrant

public ClientCredentialsGrantRequest.Builder clientCredentialsGrant()

Returns a builder that can be used to build requests for client credential grants. Requires client ID and client secret to be set.

Returns:

A builder that builds client credential grant requests.

getPlaylist

public PlaylistRequest.Builder getPlaylist(String userId,
                                  String playlistId)

Get a playlist.

Parameters:

userId - The playlist's owner's username.

playlistId - The playlist's ID.

Returns:

A builder object that can be used to build a request to retrieve a playlist.

getMe

public CurrentUserRequest.Builder getMe()

Get information about the user that has given authorization to the application.

Returns:

A builder object that can be used to build a request to retrieve information about the current user.

createPlaylist

public PlaylistCreationRequest.Builder createPlaylist(String userId,
                                             String title)

Create a playlist.

Parameters:

userId - The playlist's owner.

title - The name of the playlist.

Returns:

A builder object that can be used to build a request to create a playlist.

getArtistRelatedArtists

public RelatedArtistsRequest.Builder getArtistRelatedArtists(String artistId)

Get artists related/similar to an artist.

Parameters:

artistId - The artist's id.

Returns:

A builder object that can be used to build a request to retrieve similar artists.

getPlaylistTracks

public PlaylistTracksRequest.Builder getPlaylistTracks(String userId,
                                              String playlistId)

Get a playlist's tracks.

Parameters:

userId - The playlist's owner's username.

playlistId - The playlist's id.

Returns:

A builder object that can be used to build a request to retrieve playlist tracks.

getStarred

public PlaylistTracksRequest.Builder getStarred(String userId)

Get a user's starred tracks.

Parameters:

userId - The starred playlist's owner's username.

Returns:

A builder object that can be used to build a request to retrieve a user's starred tracks.

addTracksToPlaylist

public AddTrackToPlaylistRequest.Builder addTracksToPlaylist(String userId,
                                                    String playlistId,
                                                    List<String> trackUris)

Add tracks to a playlist.

Parameters:

userId - The owner's username.

playlistId - The playlist's ID.

trackUris - URIs of the tracks to add.

Returns:

A builder object that can e used to build a request to add tracks to a playlist.

changePlaylistDetails

public ChangePlaylistDetailsRequest.Builder changePlaylistDetails(String userId,
                                                         String playlistId)

Update a playlist's properties.

Parameters:

userId - The owner's username.

playlistId - The playlist's ID.

Returns:

A builder object that can be used to build a request to change a playlist's details.

getMySavedTracks

public GetMySavedTracksRequest.Builder getMySavedTracks()

Get a users Your Music tracks.

Returns:

A builder object that can be used to build a request to get the user's Your Music library.

containsMySavedTracks

public ContainsMySavedTracksRequest.Builder containsMySavedTracks(List<String> trackIds)

Check if a track is saved in the user's Your Music library.

Parameters:

trackIds - The tracks ids to check for in the user's Your Music library.

Returns:

A builder object that can be used to check if a user has saved a track.

removeFromMySavedTracks

public RemoveFromMySavedTracksRequest.Builder removeFromMySavedTracks(List<String> trackIds)

Remove a track if saved to the user's Your Music library.

Parameters:

trackIds - The track ids to remove from the user's Your Music library.

Returns:

A builder object that can be used to remove tracks from the user's library.

addToMySavedTracks

public AddToMySavedTracksRequest.Builder addToMySavedTracks(List<String> trackIds)

Save tracks in the user's Your Music library.

Parameters:

trackIds - The track ids to add to the user's library.

Returns:

A builder object that can be used to add tracks to the user's library.

createAuthorizeURL

public String createAuthorizeURL(List<String> scopes,
                        String state)

Retrieve a URL where the user can give the application permissions.

Parameters:

scopes - The scopes corresponding to the permissions the application needs

state - state A parameter that you can use to maintain a value between the request and the callback to redirect_uri.It is useful to prevent CSRF exploits.

Returns:

The URL where the user can give application permissions.

createAuthorizeURL

public AuthorizationURLRequest.Builder createAuthorizeURL(List<String> scopes)

Retrieve a URL where the user can give the application permissions. This method returns a builder instead, so that any optional parameters can be added.

Parameters:

scopes - The scopes corresponding to the permissions the application needs.

Returns:

A builder that when built creates a URL where the user can give the application permissions.

setAccessToken

public void setAccessToken(String accessToken)

setRefreshToken

public void setRefreshToken(String refreshToken)