Class GetUsersSavedAlbumsRequest
- java.lang.Object
-
- de.sonallux.spotify.api.apis.library.GetUsersSavedAlbumsRequest
-
public class GetUsersSavedAlbumsRequest extends Object
Get User's Saved Albums 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 album objects (wrapped in a paging object) in JSON format. Each album object is accompanied by a timestamp (added_at) to show when it was added. There is also an etag in the header that can be used in future conditional requests.On error, the header status code is an error code and the response body contains an error object.
-
-
Constructor Summary
Constructors Constructor Description GetUsersSavedAlbumsRequest(ApiClient apiClient)Get User's Saved Albums request
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiCall<Paging<SavedAlbum>>build()Build the request into an executable callGetUsersSavedAlbumsRequestlimit(int limit)The maximum number of objects to return.GetUsersSavedAlbumsRequestmarket(String market)An ISO 3166-1 alpha-2 country code or the stringfrom_token.GetUsersSavedAlbumsRequestoffset(int offset)The index of the first object to return.
-
-
-
Constructor Detail
-
GetUsersSavedAlbumsRequest
public GetUsersSavedAlbumsRequest(ApiClient apiClient)
Get User's Saved Albums request
- Parameters:
apiClient-The API client
-
-
Method Detail
-
limit
public GetUsersSavedAlbumsRequest limit(int limit)
The maximum number of objects to return. Default: 20. Minimum: 1. Maximum: 50.
-
offset
public GetUsersSavedAlbumsRequest 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.
-
market
public GetUsersSavedAlbumsRequest market(String market)
An ISO 3166-1 alpha-2 country code or the string
from_token. Provide this parameter if you want to apply Track Relinking.
-
build
public ApiCall<Paging<SavedAlbum>> build()
Build the request into an executable call
-
-