Package de.sonallux.spotify.api.apis.player

Class GetUsersCurrentlyPlayingTrackRequest

java.lang.Object
de.sonallux.spotify.api.apis.player.GetUsersCurrentlyPlayingTrackRequest
public class GetUsersCurrentlyPlayingTrackRequest extends Object

Get Currently Playing Track request

Required OAuth scopes

user-read-currently-playing

Response

Information about the currently playing track

  • Constructor Details

    • GetUsersCurrentlyPlayingTrackRequest

      public GetUsersCurrentlyPlayingTrackRequest(ApiClient apiClient)
      Get Currently Playing Track request
      Parameters:
      apiClient -

      The API client

  • Method Details

    • market

      public GetUsersCurrentlyPlayingTrackRequest 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

    • additionalTypes

      public GetUsersCurrentlyPlayingTrackRequest additionalTypes(String additionalTypes)
      Parameters:
      additionalTypes -

      A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
      Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future.
      In addition to providing this parameter, make sure that your client properly handles cases of new types in the future by checking against the type field of each object.

      Returns:
      this request

    • build

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