Interface IRequest.Builder<T, BT extends IRequest.Builder<T,?>>

Type Parameters:
T - the type of object the built request will return
BT - the specific builder type extending this interface
All Known Subinterfaces:
IPagingCursorbasedRequestBuilder<T,A,BT>, IPagingRequestBuilder<T,BT>
All Known Implementing Classes:
AbstractAuthorizationRequest.Builder, AbstractDataPagingCursorbasedRequest.Builder, AbstractDataPagingRequest.Builder, AbstractDataRequest.Builder, AbstractRequest.Builder, AddCustomPlaylistCoverImageRequest.Builder, AddItemsToPlaylistDeprecatedRequest.Builder, AddItemsToPlaylistRequest.Builder, AddItemToPlaybackQueueRequest.Builder, AuthorizationCodePKCERefreshRequest.Builder, AuthorizationCodePKCERequest.Builder, AuthorizationCodeRefreshRequest.Builder, AuthorizationCodeRequest.Builder, AuthorizationCodeUriRequest.Builder, ChangePlaylistDetailsRequest.Builder, CheckCurrentUserFollowsArtistsOrUsersRequest.Builder, CheckIfUserFollowsPlaylistRequest.Builder, CheckUsersSavedAlbumsRequest.Builder, CheckUsersSavedAudiobooksRequest.Builder, CheckUsersSavedEpisodesRequest.Builder, CheckUsersSavedItemsRequest.Builder, CheckUsersSavedShowsRequest.Builder, CheckUsersSavedTracksRequest.Builder, ClientCredentialsRequest.Builder, CreatePlaylistForUserRequest.Builder, CreatePlaylistRequest.Builder, FollowArtistsOrUsersRequest.Builder, FollowPlaylistRequest.Builder, GetAlbumRequest.Builder, GetAlbumTracksRequest.Builder, GetArtistRequest.Builder, GetArtistsAlbumsRequest.Builder, GetArtistsRelatedArtistsRequest.Builder, GetArtistsTopTracksRequest.Builder, GetAudiobookChaptersRequest.Builder, GetAudiobookRequest.Builder, GetAvailableDevicesRequest.Builder, GetAvailableMarketsRequest.Builder, GetCategoryPlaylistsRequest.Builder, GetChapterRequest.Builder, GetCurrentlyPlayingTrackRequest.Builder, GetCurrentUsersPlaylistsRequest.Builder, GetCurrentUsersProfileRequest.Builder, GetEpisodeRequest.Builder, GetFeaturedPlaylistsRequest.Builder, GetFollowedArtistsRequest.Builder, GetNewReleasesRequest.Builder, GetPlaybackStateRequest.Builder, GetPlaylistCoverImageRequest.Builder, GetPlaylistItemsDeprecatedRequest.Builder, GetPlaylistItemsRequest.Builder, GetPlaylistRequest.Builder, GetRecentlyPlayedTracksRequest.Builder, GetRecommendationGenresRequest.Builder, GetRecommendationsRequest.Builder, GetSeveralAlbumsRequest.Builder, GetSeveralArtistsRequest.Builder, GetSeveralAudiobooksRequest.Builder, GetSeveralBrowseCategoriesRequest.Builder, GetSeveralChaptersRequest.Builder, GetSeveralEpisodesRequest.Builder, GetSeveralShowsRequest.Builder, GetSeveralTracksAudioFeaturesRequest.Builder, GetSeveralTracksRequest.Builder, GetShowEpisodesRequest.Builder, GetShowRequest.Builder, GetSingleBrowseCategoryRequest.Builder, GetTrackRequest.Builder, GetTracksAudioAnalysisRequest.Builder, GetTracksAudioFeaturesRequest.Builder, GetUsersPlaylistsRequest.Builder, GetUsersProfileRequest.Builder, GetUsersQueueRequest.Builder, GetUsersSavedAlbumsRequest.Builder, GetUsersSavedAudiobooksRequest.Builder, GetUsersSavedEpisodesRequest.Builder, GetUsersSavedShowsRequest.Builder, GetUsersSavedTracksRequest.Builder, GetUsersTopArtistsAndTracksRequest.Builder, GetUsersTopArtistsRequest.Builder, GetUsersTopTracksRequest.Builder, PausePlaybackRequest.Builder, RemoveAlbumsForCurrentUserRequest.Builder, RemoveAudiobooksForCurrentUserRequest.Builder, RemoveEpisodesForCurrentUserRequest.Builder, RemoveItemsFromLibraryRequest.Builder, RemovePlaylistItemsDeprecatedRequest.Builder, RemovePlaylistItemsRequest.Builder, RemoveShowsForCurrentUserRequest.Builder, RemoveUsersSavedTracksRequest.Builder, SaveAlbumsForCurrentUserRequest.Builder, SaveAudiobooksForCurrentUserRequest.Builder, SaveEpisodesForCurrentUserRequest.Builder, SaveItemsToLibraryRequest.Builder, SaveShowsForCurrentUserRequest.Builder, SaveTracksForCurrentUserRequest.Builder, SearchAlbumsRequest.Builder, SearchAlbumsSpecialRequest.Builder, SearchArtistsRequest.Builder, SearchAudiobooksRequest.Builder, SearchEpisodesRequest.Builder, SearchForItemRequest.Builder, SearchPlaylistsRequest.Builder, SearchShowsRequest.Builder, SearchTracksRequest.Builder, SeekToPositionRequest.Builder, SetPlaybackVolumeRequest.Builder, SetRepeatModeRequest.Builder, SkipToNextRequest.Builder, SkipToPreviousRequest.Builder, StartResumePlaybackRequest.Builder, TogglePlaybackShuffleRequest.Builder, TransferPlaybackRequest.Builder, UnfollowArtistsOrUsersRequest.Builder, UnfollowPlaylistRequest.Builder, UpdatePlaylistsItemsReorderDeprecatedRequest.Builder, UpdatePlaylistsItemsReorderRequest.Builder, UpdatePlaylistsItemsReplaceDeprecatedRequest.Builder, UpdatePlaylistsItemsReplaceRequest.Builder
Enclosing interface:
IRequest<T>
public static interface IRequest.Builder<T, BT extends IRequest.Builder<T,?>>
Interface for building requests to the Spotify Web API.

  • Method Details

    • setHttpManager

      BT setHttpManager(IHttpManager httpManager)
      Set the HTTP manager for the request.
      Parameters:
      httpManager - The HTTP manager.
      Returns:
      This builder instance.

    • setScheme

      BT setScheme(String scheme)
      Set the scheme for the request.
      Parameters:
      scheme - The scheme.
      Returns:
      This builder instance.

    • setHost

      BT setHost(String host)
      Set the host for the request.
      Parameters:
      host - The host.
      Returns:
      This builder instance.

    • setPort

      BT setPort(Integer port)
      Set the port for the request.
      Parameters:
      port - The port.
      Returns:
      This builder instance.

    • setPath

      BT setPath(String path)
      Set the path for the request.
      Parameters:
      path - The path.
      Returns:
      This builder instance.

    • setPathParameter

      BT setPathParameter(String name, String value)
      Set a path parameter for the request.
      Parameters:
      name - The parameter name.
      value - The parameter value.
      Returns:
      This builder instance.

    • setDefaults

      BT setDefaults(IHttpManager httpManager, String scheme, String host, Integer port)
      Set default values for the request.
      Parameters:
      httpManager - The HTTP manager.
      scheme - The scheme.
      host - The host.
      port - The port.
      Returns:
      This builder instance.

    • setQueryParameter

      <ST> BT setQueryParameter(String name, ST value)
      Set a query parameter for the request.
      Type Parameters:
      ST - The parameter value type.
      Parameters:
      name - The parameter name.
      value - The parameter value.
      Returns:
      This builder instance.

    • setHeader

      <ST> BT setHeader(String name, ST value)
      Set a header for the request.
      Type Parameters:
      ST - The header value type.
      Parameters:
      name - The header name.
      value - The header value.
      Returns:
      This builder instance.

    • setContentType

      BT setContentType(org.apache.hc.core5.http.ContentType contentType)
      Set the content type for the request.
      Parameters:
      contentType - The content type.
      Returns:
      This builder instance.

    • setBody

      BT setBody(org.apache.hc.core5.http.HttpEntity httpEntity)
      Set the body for the request.
      Parameters:
      httpEntity - The HTTP entity body.
      Returns:
      This builder instance.

    • setBodyParameter

      <ST> BT setBodyParameter(String name, ST value)
      Set a body parameter for the request.
      Type Parameters:
      ST - The parameter value type.
      Parameters:
      name - The parameter name.
      value - The parameter value.
      Returns:
      This builder instance.

    • build

      IRequest<T> build()
      Build the request.
      Returns:
      The constructed request.