Class GetShowsEpisodesRequest
- java.lang.Object
-
- de.sonallux.spotify.api.apis.shows.GetShowsEpisodesRequest
-
public class GetShowsEpisodesRequest extends Object
Get a Show's Episodes requestResponse
On success, the HTTP status code in the response header is
200OK and the response body contains an array of simplified episode objects (wrapped in a paging object) in JSON format.On error, the header status code is an error code and the response body contains an error object.
If a show is unavailable in the given
marketthe HTTP status code in the response header is404NOT FOUND. Unavailable episodes are filtered out.
-
-
Constructor Summary
Constructors Constructor Description GetShowsEpisodesRequest(ApiClient apiClient, String id)Get a Show's Episodes request
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiCall<Paging<SimplifiedEpisode>>build()Build the request into an executable callGetShowsEpisodesRequestlimit(int limit)The maximum number of episodes to return.GetShowsEpisodesRequestmarket(String market)GetShowsEpisodesRequestoffset(int offset)The index of the first episode to return.
-
-
-
Constructor Detail
-
GetShowsEpisodesRequest
public GetShowsEpisodesRequest(ApiClient apiClient, String id)
Get a Show's Episodes request
- Parameters:
apiClient-The API client
id-The Spotify ID for the show.
-
-
Method Detail
-
market
public GetShowsEpisodesRequest market(String market)
An ISO 3166-1 alpha-2 country code. 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.
-
limit
public GetShowsEpisodesRequest limit(int limit)
The maximum number of episodes to return. Default: 20. Minimum: 1. Maximum: 50.
-
offset
public GetShowsEpisodesRequest offset(int offset)
The index of the first episode to return. Default: 0 (the first object). Use with limit to get the next set of episodes.
-
build
public ApiCall<Paging<SimplifiedEpisode>> build()
Build the request into an executable call
-
-