Constructor Detail

Method Detail

• startDownload

   static DownloadJob startDownload(@NonNull() DownloadRequest request)

  Create a new DownloadJob from a DownloadRequest.

  Parameters:

  request - DownloadRequest that should be executed.

  Returns:

  An initialized and running DownloadJob based on the given request.

• getOutputFile

   File getOutputFile()

  Returns the output file as defined by the started DownloadRequest.

  Returns:

  File pointing to the download output.

• cancel

   void cancel()

  Cancel the running download. Listeners won't receive a completion event after calling this method.

• isComplete

   boolean isComplete()

  Returns true if the download has been successfully completed.

  Returns:

  true if the download has been completed, otherwise false.

• getProgress

   Flowable<Progress> getProgress()

  Returns an Observable that emits Progress events of the download. When using this, make sure to properly handle back pressure.

  Returns:

  A Observable emitting download Progress events.

• setProgressListener

   void setProgressListener(@Nullable() DownloadJob.ProgressListener progressListener)

  Sets a ProgressListener for monitoring the download. Calling this method will replace any previously set listener. You may provide null to clear the listener.

  Note: Progress listener methods will be notified on the main thread.

  Parameters:

  progressListener - ProgressListener that should be notified, or null to clear the listener.