Class TransferUsersPlaybackRequest


  • public class TransferUsersPlaybackRequest
    extends Object
    Transfer a User's Playback request

    Required OAuth scopes

    user-modify-playback-state

    Response

    A completed request will return a 204 NO CONTENT response code, and then issue the command to the player. Due to the asynchronous nature of the issuance of the command, you should use the Get Information About The User's Current Playback endpoint to check that your issued command was handled correctly by the player.

    If the device is not found, the request will return 404 NOT FOUND response code.

    If the user making the request is non-premium, a 403 FORBIDDEN response code will be returned.

    • Constructor Detail

      • TransferUsersPlaybackRequest

        public TransferUsersPlaybackRequest​(ApiClient apiClient,
                                            List<String> deviceIds)

        Transfer a User's Playback request

        Parameters:
        apiClient -

        The API client

        deviceIds -

        A JSON array containing the ID of the device on which playback should be started/transferred.
        For example:{device_ids:["74ASZWbe4lXaubB36ztrGX"]}
        Note: Although an array is accepted, only a single device_id is currently supported. Supplying more than one will return 400 Bad Request

    • Method Detail

      • play

        public TransferUsersPlaybackRequest play​(boolean play)

        true : ensure playback happens on new device.
        false or not provided: keep the current playback state.

      • build

        public ApiCall<Void> build()
        Build the request into an executable call