pspdfkit/com.pspdfkit.document.download/DownloadJob

DownloadJob

open class DownloadJob

A task that can download a PDF document from a DownloadSource. You can create and start a job using startDownload. To monitor the download progress you can either set a listener using setProgressListener or retrieve a progress observable using getProgress.

Types

Link copied to clipboard
interface ProgressListener
Definition of callback objects for observing downloads.
Link copied to clipboard
abstract class ProgressListenerAdapter : DownloadJob.ProgressListener
An empty implementation of a ProgressListener.

Functions

Link copied to clipboard
open fun cancel()
Cancel the running download.
Link copied to clipboard
open fun getOutputFile(): File
Returns the output file as defined by the started DownloadRequest.
Link copied to clipboard
open fun getProgress(): Flowable<Progress>
Returns an Observable that emits Progress events of the download.
Link copied to clipboard
open fun isComplete(): Boolean
Returns true if the download has been successfully completed.
Link copied to clipboard
open fun setProgressListener(@Nullable progressListener: DownloadJob.ProgressListener)
Sets a ProgressListener for monitoring the download.
Link copied to clipboard
open fun startDownload(@NonNull request: DownloadRequest): DownloadJob
Create a new DownloadJob from a DownloadRequest.