Class GetUsersSavedEpisodesRequest
- java.lang.Object
-
- de.sonallux.spotify.api.apis.library.GetUsersSavedEpisodesRequest
-
public class GetUsersSavedEpisodesRequest extends Object
Get User's Saved Episodes requestRequired OAuth scopes
user-library-readResponse
- On success, the HTTP status code in the response header is
200OK and the response body contains an array of saved 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.
- On success, the HTTP status code in the response header is
-
-
Constructor Summary
Constructors Constructor Description GetUsersSavedEpisodesRequest(ApiClient apiClient)Get User's Saved Episodes request
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiCall<Paging<SavedEpisode>>build()Build the request into an executable callGetUsersSavedEpisodesRequestlimit(int limit)The maximum number of objects to return.GetUsersSavedEpisodesRequestmarket(String market)GetUsersSavedEpisodesRequestoffset(int offset)The index of the first object to return.
-
-
-
Constructor Detail
-
GetUsersSavedEpisodesRequest
public GetUsersSavedEpisodesRequest(ApiClient apiClient)
Get User's Saved Episodes request
- Parameters:
apiClient-The API client
-
-
Method Detail
-
market
public GetUsersSavedEpisodesRequest market(String market)
An ISO 3166-1 alpha-2 country code. If a country code is specified, only 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 GetUsersSavedEpisodesRequest limit(int limit)
The maximum number of objects to return. Default: 20. Minimum: 1. Maximum: 50.
-
offset
public GetUsersSavedEpisodesRequest offset(int offset)
The index of the first object to return. Default: 0 (i.e., the first object). Use with
limitto get the next set of objects.
-
build
public ApiCall<Paging<SavedEpisode>> build()
Build the request into an executable call
-
-