Package com.downloader

Class PRDownloader

java.lang.Object

com.downloader.PRDownloader

public class PRDownloader
extends java.lang.Object

PRDownloader entry point. You must initialize this class before use. The simplest way is to just do {#code PRDownloader.initialize(context)}.

Method Summary

Modifier and Type	Method	Description
static void	cancel(int downloadId)	Method to cancel request with the given downloadId
static void	cancel(java.lang.Object tag)	Method to cancel requests with the given tag
static void	cancelAll()	Method to cancel all requests
static void	cleanUp(int days)	Method to clean up temporary resumed files which is older than the given day
static DownloadRequestBuilder	download(java.lang.String url, java.lang.String dirPath, java.lang.String fileName)	Method to make download request
static Status	getStatus(int downloadId)	Method to check the request with the given downloadId is running or not
static void	initialize(android.content.Context context)	Initializes PRDownloader with the default config.
static void	initialize(android.content.Context context, PRDownloaderConfig config)	Initializes PRDownloader with the custom config.
static void	pause(int downloadId)	Method to pause request with the given downloadId
static void	resume(int downloadId)	Method to resume request with the given downloadId
static void	shutDown()	Shuts PRDownloader down

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

initialize

public static void initialize(android.content.Context context)

Initializes PRDownloader with the default config.

Parameters:

context - The context

initialize

public static void initialize(android.content.Context context,
                              PRDownloaderConfig config)

Initializes PRDownloader with the custom config.

Parameters:

context - The context

config - The PRDownloaderConfig

download

public static DownloadRequestBuilder download(java.lang.String url,
                                              java.lang.String dirPath,
                                              java.lang.String fileName)

Method to make download request

Parameters:

url - The url on which request is to be made

dirPath - The directory path on which file is to be saved

fileName - The file name with which file is to be saved

Returns:

the DownloadRequestBuilder

pause

public static void pause(int downloadId)

Method to pause request with the given downloadId

Parameters:

downloadId - The downloadId with which request is to be paused

resume

public static void resume(int downloadId)

Method to resume request with the given downloadId

Parameters:

downloadId - The downloadId with which request is to be resumed

cancel

public static void cancel(int downloadId)

Method to cancel request with the given downloadId

Parameters:

downloadId - The downloadId with which request is to be cancelled

cancel

public static void cancel(java.lang.Object tag)

Method to cancel requests with the given tag

Parameters:

tag - The tag with which requests are to be cancelled

cancelAll

public static void cancelAll()

Method to cancel all requests

getStatus

public static Status getStatus(int downloadId)

Method to check the request with the given downloadId is running or not

Parameters:

downloadId - The downloadId with which request status is to be checked

Returns:

the running status

cleanUp

public static void cleanUp(int days)

Method to clean up temporary resumed files which is older than the given day

Parameters:

days - the days

shutDown

public static void shutDown()

Shuts PRDownloader down