Package de.sonallux.spotify.api.apis.albums

Class GetUsersSavedAlbumsRequest

java.lang.Object
de.sonallux.spotify.api.apis.albums.GetUsersSavedAlbumsRequest
public class GetUsersSavedAlbumsRequest extends Object

Get User's Saved Albums request

Required OAuth scopes

user-library-read

Response

Pages of albums

  • Constructor Details

    • GetUsersSavedAlbumsRequest

      public GetUsersSavedAlbumsRequest(ApiClient apiClient)
      Get User's Saved Albums request
      Parameters:
      apiClient -

      The API client

  • Method Details

    • limit

      public GetUsersSavedAlbumsRequest limit(int limit)
      Parameters:
      limit -

      The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

      Returns:
      this request

    • offset

      public GetUsersSavedAlbumsRequest offset(int offset)
      Parameters:
      offset -

      The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

      Returns:
      this request

    • market

      public GetUsersSavedAlbumsRequest market(String market)
      Parameters:
      market -

      An ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is 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.

      Returns:
      this request

    • build

      public ApiCall<Paging<SavedAlbum>> build()
      Build the request into an executable api call
      Returns:
      an executable api call