Class LibraryApi

    • Constructor Detail

      • LibraryApi

        public LibraryApi()
    • Method Detail

      • checkUsersSavedAlbums

        public CheckUsersSavedAlbumsRequest checkUsersSavedAlbums​(String ids)

        Check User's Saved Albums

        Check if one or more albums is already saved in the current Spotify user's 'Your Music' library.

        Parameters:
        ids -

        A comma-separated list of the Spotify IDs for the albums. Maximum: 50 IDs.

        Returns:
        a CheckUsersSavedAlbumsRequest object to build and execute the request
      • checkUsersSavedEpisodes

        public CheckUsersSavedEpisodesRequest checkUsersSavedEpisodes​(String ids)

        Check User's Saved Episodes

        Check if one or more episodes is already saved in the current Spotify user's 'Your Episodes' library.

        This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum..

        Parameters:
        ids -

        A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs.

        Returns:
        a CheckUsersSavedEpisodesRequest object to build and execute the request
      • checkUsersSavedShows

        public CheckUsersSavedShowsRequest checkUsersSavedShows​(String ids)

        Check User's Saved Shows

        Check if one or more shows is already saved in the current Spotify user's library.

        Parameters:
        ids -

        A comma-separated list of the Spotify IDs for the shows. Maximum: 50 ids.

        Returns:
        a CheckUsersSavedShowsRequest object to build and execute the request
      • checkUsersSavedTracks

        public CheckUsersSavedTracksRequest checkUsersSavedTracks​(String ids)

        Check User's Saved Tracks

        Check if one or more tracks is already saved in the current Spotify user's 'Your Music' library.

        Parameters:
        ids -

        A comma-separated list of the Spotify IDs for the tracks. Maximum: 50 IDs.

        Returns:
        a CheckUsersSavedTracksRequest object to build and execute the request
      • getUsersSavedAlbums

        public GetUsersSavedAlbumsRequest getUsersSavedAlbums()

        Get User's Saved Albums

        Get a list of the albums saved in the current Spotify user's 'Your Music' library.

        Returns:
        a GetUsersSavedAlbumsRequest object to build and execute the request
      • getUsersSavedEpisodes

        public GetUsersSavedEpisodesRequest getUsersSavedEpisodes()

        Get User's Saved Episodes

        Get a list of the episodes saved in the current Spotify user's library.

        This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.

        Returns:
        a GetUsersSavedEpisodesRequest object to build and execute the request
      • getUsersSavedShows

        public GetUsersSavedShowsRequest getUsersSavedShows()

        Get User's Saved Shows

        Get a list of shows saved in the current Spotify user's library. Optional parameters can be used to limit the number of shows returned.

        Returns:
        a GetUsersSavedShowsRequest object to build and execute the request
      • getUsersSavedTracks

        public GetUsersSavedTracksRequest getUsersSavedTracks()

        Get User's Saved Tracks

        Get a list of the songs saved in the current Spotify user's 'Your Music' library.

        Returns:
        a GetUsersSavedTracksRequest object to build and execute the request
      • removeAlbumsUser

        public RemoveAlbumsUserRequest removeAlbumsUser​(List<String> ids)

        Remove Albums for Current User

        Remove one or more albums from the current user's 'Your Music' library.

        Parameters:
        ids -

        A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]
        A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.

        Returns:
        a RemoveAlbumsUserRequest object to build and execute the request
      • removeEpisodesUser

        public RemoveEpisodesUserRequest removeEpisodesUser​(List<String> ids)

        Remove User's Saved Episodes

        Remove one or more episodes from the current user's library.

        This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.

        Parameters:
        ids -

        A JSON array of the Spotify IDs.
        A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.

        Returns:
        a RemoveEpisodesUserRequest object to build and execute the request
      • removeShowsUser

        public RemoveShowsUserRequest removeShowsUser​(List<String> ids)

        Remove User's Saved Shows

        Delete one or more shows from current Spotify user's library.

        Parameters:
        ids -

        A JSON array of the Spotify IDs.
        A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.

        Returns:
        a RemoveShowsUserRequest object to build and execute the request
      • removeTracksUser

        public RemoveTracksUserRequest removeTracksUser​(List<String> ids)

        Remove User's Saved Tracks

        Remove one or more tracks from the current user's 'Your Music' library.

        Parameters:
        ids -

        A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]
        A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.

        Returns:
        a RemoveTracksUserRequest object to build and execute the request
      • saveAlbumsUser

        public SaveAlbumsUserRequest saveAlbumsUser​(List<String> ids)

        Save Albums for Current User

        Save one or more albums to the current user's 'Your Music' library.

        Parameters:
        ids -

        A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]
        A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.

        Returns:
        a SaveAlbumsUserRequest object to build and execute the request
      • saveEpisodesUser

        public SaveEpisodesUserRequest saveEpisodesUser​(List<String> ids)

        Save Episodes for User

        Save one or more episodes to the current user's library.

        This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.

        Parameters:
        ids -

        A JSON array of the Spotify IDs.
        A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.

        Returns:
        a SaveEpisodesUserRequest object to build and execute the request
      • saveShowsUser

        public SaveShowsUserRequest saveShowsUser​(List<String> ids)

        Save Shows for Current User

        Save one or more shows to current Spotify user's library.

        Parameters:
        ids -

        A JSON array of the Spotify IDs.
        A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.

        Returns:
        a SaveShowsUserRequest object to build and execute the request
      • saveTracksUser

        public SaveTracksUserRequest saveTracksUser​(List<String> ids)

        Save Tracks for User

        Save one or more tracks to the current user's 'Your Music' library.

        Parameters:
        ids -

        A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]
        A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.

        Returns:
        a SaveTracksUserRequest object to build and execute the request