de.sonallux.spotify.api.apis.albums.CheckUsersSavedAlbumsRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spotify-web-api-java Show documentation

A Java wrapper for Spotify's Web API

The newest version!

package de.sonallux.spotify.api.apis.albums;

import com.fasterxml.jackson.core.type.TypeReference;
import de.sonallux.spotify.api.http.ApiCall;
import de.sonallux.spotify.api.http.ApiClient;
import de.sonallux.spotify.api.http.Request;
import de.sonallux.spotify.api.models.*;

/**
 * Check User's Saved Albums request
 *
 * Required OAuth scopes
 * user-library-read
 *
 * Response
 * Array of booleans
 */
public class CheckUsersSavedAlbumsRequest {
    private static final TypeReference> RESPONSE_TYPE = new TypeReference<>() {};
    private final ApiClient apiClient;
    private final Request request;

    /**
     * Check User's Saved Albums request
     * @param apiClient The API client
     * @param ids A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs.
     */
    public CheckUsersSavedAlbumsRequest(ApiClient apiClient, String ids) {
        this.apiClient = apiClient;
        this.request = new Request("GET", "/me/albums/contains")
            .addQueryParameter("ids", String.valueOf(ids))
        ;
    }

    /**
     * Build the request into an executable api call
     * @return an executable api call
     */
    public ApiCall> build() {
        return apiClient.createApiCall(request, RESPONSE_TYPE);
    }
}