All Downloads are FREE. Search and download functionalities are using the official Maven repository.

se.michaelthelin.spotify.requests.data.episodes.GetEpisodeRequest Maven / Gradle / Ivy

There is a newer version: 9.0.0-RC1
Show newest version
package se.michaelthelin.spotify.requests.data.episodes;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.neovisionaries.i18n.CountryCode;
import org.apache.hc.core5.http.ParseException;
import se.michaelthelin.spotify.exceptions.SpotifyWebApiException;
import se.michaelthelin.spotify.model_objects.specification.Episode;
import se.michaelthelin.spotify.requests.data.AbstractDataRequest;

import java.io.IOException;

/**
 * Get Spotify catalog information for a single episode identified by its unique Spotify ID.
 */
@JsonDeserialize(builder = GetEpisodeRequest.Builder.class)
public class GetEpisodeRequest extends AbstractDataRequest {

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

  /**
   * Get an episode
   *
   * @return An {@link Episode}.
   * @throws IOException            In case of networking issues.
   * @throws SpotifyWebApiException The Web API returned an error further specified in this exception's root cause.
   */
  @Override
  public Episode execute() throws
    IOException,
    SpotifyWebApiException,
    ParseException {
    return new Episode.JsonUtil().createModelObject(getJson());
  }

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

    /**
     * Create a new {@link GetEpisodeRequest.Builder}.
     * 

* Reading the user’s resume points on episode objects requires the {@code user-read-playback-position} scope. * * @param accessToken Required. A valid access token from the Spotify Accounts service. */ public Builder(final String accessToken) { super(accessToken); } /** * The episode ID setter. * * @param id The Spotify ID for the episode. * @return A {@link GetEpisodeRequest.Builder}. * @see Spotify: URIs & IDs */ public Builder id(final String id) { assert (id != null); assert (!id.equals("")); return setPathParameter("id", id); } /** * The market country code setter.

* If a country code is specified, only shows and episodes that are available in that market will be returned. * If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter. * Note: If neither market or user country are provided, the content is considered unavailable for the client.

* Users can view the country that is associated with their account in the account settings. * * @param market Optional. An ISO 3166-1 alpha-2 country code. * @return A {@link GetEpisodeRequest.Builder}. * @see Wikipedia: ISO 3166-1 alpha-2 country codes */ public Builder market(final CountryCode market) { assert (market != null); return setQueryParameter("market", market); } /** * The request build method. * * @return A custom {@link GetEpisodeRequest}. */ @Override public GetEpisodeRequest build() { setPath("/v1/episodes/{id}"); return new GetEpisodeRequest(this); } @Override protected GetEpisodeRequest.Builder self() { return this; } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy