se.michaelthelin.spotify.requests.data.episodes.GetSeveralEpisodesRequest Maven / Gradle / Ivy
Show all versions of spotify-web-api-java Show documentation
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 multiple episodes based on their Spotify IDs.
*/
@JsonDeserialize(builder = GetSeveralEpisodesRequest.Builder.class)
public class GetSeveralEpisodesRequest extends AbstractDataRequest {
/**
* The private {@link GetSeveralEpisodesRequest} constructor.
*
* @param builder A {@link GetSeveralEpisodesRequest.Builder}.
*/
private GetSeveralEpisodesRequest(final Builder builder) {
super(builder);
}
/**
* Get several episodes.
*
* @return Multiple {@link Episode} objects.
* @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().createModelObjectArray(getJson(), "episodes");
}
/**
* Builder class for building a {@link GetSeveralEpisodesRequest}.
*/
public static final class Builder extends AbstractDataRequest.Builder {
/**
* Create a new {@link GetSeveralEpisodesRequest.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 IDs setter.
*
* @param ids Required. A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs.
* @return A {@link GetSeveralEpisodesRequest.Builder}.
* @see Spotify: URIs & IDs
*/
public Builder ids(final String ids) {
assert (ids != null);
assert (ids.split(",").length <= 50);
return setQueryParameter("ids", ids);
}
/**
* 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 GetSeveralEpisodesRequest.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 GetSeveralEpisodesRequest}.
*/
@Override
public GetSeveralEpisodesRequest build() {
setPath("/v1/episodes");
return new GetSeveralEpisodesRequest(this);
}
@Override
protected GetSeveralEpisodesRequest.Builder self() {
return this;
}
}
}