zlc.season.rxdownload

类 RxDownload

java.lang.Object

zlc.season.rxdownload.RxDownload

public class RxDownload
extends java.lang.Object

Author: Season(ssseasonnn@gmail.com) Date: 2016/10/19 Time: 10:46 RxDownload

方法概要

限定符和类型	方法和说明
<any>	cancelServiceDownload(java.lang.String url) 取消Service中下载地址为url的下载任务.
RxDownload	context(android.content.Context context) 普通下载时不需要context, 使用Service下载时需要context;
RxDownload	defaultSavePath(java.lang.String savePath)
<any>	deleteServiceDownload(java.lang.String url) 删除Service中下载地址为url的下载任务.
<any>	download(java.lang.String url, java.lang.String saveName, java.lang.String savePath) 普通下载, 不使用Service.
<any>	getDownloadRecord(java.lang.String url) 从数据库中读取下载地址为url的下载记录
static RxDownload	getInstance()
<any>	getTotalDownloadRecords() 从数据库中读取所有的下载任务
RxDownload	maxRetryCount(int max)
RxDownload	maxThread(int max)
<any>	pauseServiceDownload(java.lang.String url) 暂停Service中下载地址为url的下载任务.
<any>	registerReceiver(java.lang.String url) 为Service中下载地址为url的下载任务注册广播接收器,用于接收该任务的下载进度.
RxDownload	retrofit(Retrofit retrofit)
<any>	serviceDownload(java.lang.String url, java.lang.String saveName, java.lang.String savePath) 使用Service下载.
<any>	serviceDownload(java.lang.String url, java.lang.String saveName, java.lang.String savePath, java.lang.String displayName, java.lang.String displayImage) 使用Service下载.
<any>	serviceDownloadNoReceiver(java.lang.String url, java.lang.String saveName, java.lang.String savePath) 使用Service下载.
<any>	serviceDownloadNoReceiver(java.lang.String url, java.lang.String saveName, java.lang.String savePath, java.lang.String displayName, java.lang.String displayImage) 使用Service下载.
<T> <any>	transform(java.lang.String url, java.lang.String saveName, java.lang.String savePath) 普通下载的Transformer版本.
<T> <any>	transformService(java.lang.String url, java.lang.String saveName, java.lang.String savePath) ServiceDownload的Transformer版本.
<T> <any>	transformService(java.lang.String url, java.lang.String saveName, java.lang.String savePath, java.lang.String displayName, java.lang.String displayImage) 同上
<T> <any>	transformServiceNoReceiver(java.lang.String url, java.lang.String saveName, java.lang.String savePath) ServiceDownloadNoReceiver的Transformer版本 提供给RxJava Compose操作符使用.
<T> <any>	transformServiceNoReceiver(java.lang.String url, java.lang.String saveName, java.lang.String savePath, java.lang.String displayName, java.lang.String displayImage) 同上

从类继承的方法 java.lang.Object

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

方法详细资料

getInstance

public static RxDownload getInstance()

context

public RxDownload context(android.content.Context context)

普通下载时不需要context, 使用Service下载时需要context;

参数:

context - context

返回:

RxDownload

defaultSavePath

public RxDownload defaultSavePath(java.lang.String savePath)

retrofit

public RxDownload retrofit(Retrofit retrofit)

maxThread

public RxDownload maxThread(int max)

maxRetryCount

public RxDownload maxRetryCount(int max)

registerReceiver

public <any> registerReceiver(java.lang.String url)

为Service中下载地址为url的下载任务注册广播接收器,用于接收该任务的下载进度. 注意只接收下载地址为url的下载进度. 取消订阅即可取消注册.

参数:

url - download url

返回:

Observable

getTotalDownloadRecords

public <any> getTotalDownloadRecords()

从数据库中读取所有的下载任务

返回:

Observable>

getDownloadRecord

public <any> getDownloadRecord(java.lang.String url)

从数据库中读取下载地址为url的下载记录

参数:

url - download url

返回:

Observable

pauseServiceDownload

public <any> pauseServiceDownload(java.lang.String url)

暂停Service中下载地址为url的下载任务. 同时标记数据库中的下载记录为暂停状态.

参数:

url - download url

cancelServiceDownload

public <any> cancelServiceDownload(java.lang.String url)

取消Service中下载地址为url的下载任务. 同时标记数据库中的下载记录为取消状态. 不会删除已经下载的文件.

参数:

url - download url

deleteServiceDownload

public <any> deleteServiceDownload(java.lang.String url)

删除Service中下载地址为url的下载任务. 同时从数据库中删除该下载记录. 不会删除已经下载的文件.

参数:

url - download url

serviceDownload

public <any> serviceDownload(java.lang.String url,
                             java.lang.String saveName,
                             java.lang.String savePath)

使用Service下载. 同时注册了广播接收器接收下载进度. 取消订阅即可取消注册, 但不会暂停下载. 同时在数据库中保存下载记录.

参数:

url - 下载文件的Url

saveName - 下载文件的保存名称

savePath - 下载文件的保存路径, null使用默认的路径,默认保存在/storage/emulated/0/Download/目录下

返回:

Observable

serviceDownload

public <any> serviceDownload(java.lang.String url,
                             java.lang.String saveName,
                             java.lang.String savePath,
                             java.lang.String displayName,
                             java.lang.String displayImage)

使用Service下载. 同时注册广播接收器接收下载进度. 取消订阅即可取消注册, 不会暂停下载. 同时在数据库中保存下载记录.

参数:

url - 下载文件的Url

saveName - 下载文件的保存名称

savePath - 下载文件的保存路径, null使用默认的路径,默认保存在/storage/emulated/0/Download/目录下

displayName - 可选参数, 显示在下载记录中的名称. 如需要在下载记录中显示名称,传入此参数保存到下载记录中

displayImage - 可选参数, 显示在下载记录中的图片. 如需要在下载记录中显示图片或图标,传入此参数保存到下载记录中

返回:

Observable

serviceDownloadNoReceiver

public <any> serviceDownloadNoReceiver(java.lang.String url,
                                       java.lang.String saveName,
                                       java.lang.String savePath)

使用Service下载. 不会注册广播接收器,接收下载进度请手动注册广播接收器. 取消订阅不会暂停下载. 同时在数据库中保存下载记录.

参数:

url - 下载文件的Url

saveName - 下载文件的保存名称

savePath - 下载文件的保存路径, null使用默认的路径,默认保存在/storage/emulated/0/Download/目录下

返回:

Observable emit a NULL object

serviceDownloadNoReceiver

public <any> serviceDownloadNoReceiver(java.lang.String url,
                                       java.lang.String saveName,
                                       java.lang.String savePath,
                                       java.lang.String displayName,
                                       java.lang.String displayImage)

使用Service下载. 不会注册广播接收器,接收下载进度请手动注册广播接收器. 取消订阅不会暂停下载. 同时在数据库中保存下载记录.

参数:

url - 下载文件的Url

saveName - 下载文件的保存名称

savePath - 下载文件的保存路径, null使用默认的路径,默认保存在/storage/emulated/0/Download/目录下

displayName - 可选参数, 显示在下载记录中的名称. 如需要在下载记录中显示名称,传入此参数保存到下载记录中

displayImage - 可选参数, 显示在下载记录中的图片. 如需要在下载记录中显示图片或图标,传入此参数保存到下载记录中

返回:

Observable emit a NULL object

download

public <any> download(java.lang.String url,
                      java.lang.String saveName,
                      java.lang.String savePath)

普通下载, 不使用Service. 取消订阅则暂停下载. 不会在数据库中保存下载记录.

参数:

url - 下载文件的Url

saveName - 下载文件的保存名称

savePath - 下载文件的保存路径, null使用默认的路径,默认保存在/storage/emulated/0/Download/目录下

返回:

Observable

transform

public <T> <any> transform(java.lang.String url,
                           java.lang.String saveName,
                           java.lang.String savePath)

普通下载的Transformer版本. 提供给RxJava Compose操作符使用.

类型参数:

T - T

参数:

url - 下载文件的Url

saveName - 下载文件的保存名称

savePath - 下载文件的保存路径, null使用默认的路径,默认保存在/storage/emulated/0/Download/目录下

返回:

Transformer

transformService

public <T> <any> transformService(java.lang.String url,
                                  java.lang.String saveName,
                                  java.lang.String savePath)

ServiceDownload的Transformer版本. 提供给RxJava Compose操作符使用.

类型参数:

T - T

参数:

url - 下载文件的Url

saveName - 下载文件的保存名称

savePath - 下载文件的保存路径, null使用默认的路径,默认保存在/storage/emulated/0/Download/目录下

返回:

Transformer

transformService

public <T> <any> transformService(java.lang.String url,
                                  java.lang.String saveName,
                                  java.lang.String savePath,
                                  java.lang.String displayName,
                                  java.lang.String displayImage)

同上

类型参数:

T - T

参数:

url - url

saveName - saveName

savePath - savePath

displayName - display name in download record

displayImage - display image in download record

返回:

Transformer

transformServiceNoReceiver

public <T> <any> transformServiceNoReceiver(java.lang.String url,
                                            java.lang.String saveName,
                                            java.lang.String savePath)

ServiceDownloadNoReceiver的Transformer版本 提供给RxJava Compose操作符使用.

类型参数:

T - T

参数:

url - 下载文件的Url

saveName - 下载文件的保存名称

savePath - 下载文件的保存路径, null使用默认的路径,默认保存在/storage/emulated/0/Download/目录下

返回:

Transformer

transformServiceNoReceiver

public <T> <any> transformServiceNoReceiver(java.lang.String url,
                                            java.lang.String saveName,
                                            java.lang.String savePath,
                                            java.lang.String displayName,
                                            java.lang.String displayImage)

同上

类型参数:

T - T

参数:

url - url

saveName - saveName

savePath - savePath

displayName - display name in download record

displayImage - display image in download record

返回:

Transformer