se.michaelthelin.spotify.requests.data.player.ToggleShuffleForUsersPlaybackRequest 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 client for Spotify's Web API
There is a newer version: 9.0.0-RC1
package se.michaelthelin.spotify.requests.data.player;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import org.apache.hc.core5.http.ContentType;
import org.apache.hc.core5.http.ParseException;
import se.michaelthelin.spotify.exceptions.SpotifyWebApiException;
import se.michaelthelin.spotify.requests.data.AbstractDataRequest;

import java.io.IOException;

/**
 * Toggle shuffle on or off for user’s playback.
 */
@JsonDeserialize(builder = ToggleShuffleForUsersPlaybackRequest.Builder.class)
public class ToggleShuffleForUsersPlaybackRequest extends AbstractDataRequest {

  /**
   * The private {@link ToggleShuffleForUsersPlaybackRequest} constructor.
   *
   * @param builder A {@link ToggleShuffleForUsersPlaybackRequest.Builder}.
   */
  private ToggleShuffleForUsersPlaybackRequest(final Builder builder) {
    super(builder);
  }

  /**
   * Toggle the shuffle state of an user's playback.
   *
   * @return A string. Note: This endpoint doesn't return something in its response body.
   * @throws IOException            In case of networking issues.
   * @throws SpotifyWebApiException The Web API returned an error further specified in this exception's root cause.
   */
  public String execute() throws
    IOException,
    SpotifyWebApiException,
    ParseException {
    return putJson();
  }

  /**
   * Builder class for building a {@link ToggleShuffleForUsersPlaybackRequest}.
   */
  public static final class Builder extends AbstractDataRequest.Builder {

    /**
     * Create a new {@link ToggleShuffleForUsersPlaybackRequest.Builder}.
     * 
     * Your access token must have the {@code user-modify-playback-state} scope authorized in order to control playback.
     *
     * @param accessToken Required. A valid access token from the Spotify Accounts service.
     * @see Spotify: Using Scopes
     */
    public Builder(final String accessToken) {
      super(accessToken);
    }

    /**
     * The toggle state setter.
     *
     * @param state Required. {@code true}: Shuffle user's playback. {@code false}: Do not shuffle user's playback.
     * @return A {@link ToggleShuffleForUsersPlaybackRequest.Builder}.
     */
    public Builder state(final Boolean state) {
      return setQueryParameter("state", state);
    }

    /**
     * The device ID setter.
     *
     * @param device_id Optional. The ID of the device this command is targeting. If not supplied, the
     *                  user's currently active device is the target.
     * @return A {@link ToggleShuffleForUsersPlaybackRequest.Builder}.
     * @see Spotify: URIs & IDs
     */
    public Builder device_id(final String device_id) {
      assert (device_id != null);
      assert (!device_id.equals(""));
      return setQueryParameter("device_id", device_id);
    }

    /**
     * The request build method.
     *
     * @return A custom {@link ToggleShuffleForUsersPlaybackRequest}.
     */
    @Override
    public ToggleShuffleForUsersPlaybackRequest build() {
      setContentType(ContentType.APPLICATION_JSON);
      setPath("/v1/me/player/shuffle");
      return new ToggleShuffleForUsersPlaybackRequest(this);
    }

    @Override
    protected Builder self() {
      return this;
    }
  }
}