app-updater/com.king.app.updater/AppUpdater/Builder

Builder

class Builder(context: Context)

AppUpdater.Builder

Constructors

constructor(context: Context)

Properties

var apkMd5: String?

APK文件的MD5

var authority: String

默认 Context.getPackageName() + ".AppUpdaterFileProvider"

cancelDownloadOnNotification

var cancelDownloadOnNotification: Boolean

是否支持通过删除通知栏来取消下载

var channelId: String

通知栏渠道ID

var channelName: String

通知栏渠道名称

deleteFileOnCancel

var deleteFileOnCancel: Boolean

是否删除取消下载的文件

downloadListener

var downloadListener: DownloadListener?

下载监听

var filename: String?

保存的apk文件名；例如：app.apk

var headers: MutableMap<String, String>

请求头参数

var httpManager: IHttpManager

HTTP管理器

var installApk: Boolean

下载完成后是否自动请求安装APK

var isSound: Boolean

是否铃声提示，为true时使用通知默认铃声

var isVibrate: Boolean

是否震动提示，为true时使用通知默认震动

var maxRetryCount: Int

下载失败后，最大重新下载次数

notificationHandler

var notificationHandler: INotificationHandler

通知栏处理器实现

notificationIcon

var notificationIcon: Int

通知栏图标：默认取app图标

var notificationId: Int

通知栏ID

progressUpdateInterval

var progressUpdateInterval: Long

进度更新间隔时长（单位：毫秒）

retryOnNotification

var retryOnNotification: Boolean

下载失败时是否支持点击通知栏重新下载

showNotification

var showNotification: Boolean

是否显示通知栏

var showPercentage: Boolean

是否显示百分比

var url: String?

APK下载地址

var versionCode: Int

要下载的APK的versionCode

Functions

fun addHeader(headers: Map<String, String>): AppUpdater.Builder

fun addHeader(key: String, value: String): AppUpdater.Builder

添加请求头

fun build(): AppUpdater

构建AppUpdater

fun clearHeaders(): AppUpdater.Builder

清空请求头

fun removeHeader(key: String): AppUpdater.Builder

移除请求头

fun setApkMd5(md5: String): AppUpdater.Builder

设置APK文件的MD5，用于优先取缓存时通过MD5校验文件APK是否一致。缓存校验目前支持两种方式，一种是通过versionCode校验，对应方法：setVersionCode；一种是文件MD5校验，对应方法：setApkMd5。推荐使用MD5校验方式如果两种方式都设置了，则只校验MD5

fun setAuthority(authority: String): AppUpdater.Builder

设置FileProvider的authority

setCancelDownloadOnNotification

fun setCancelDownloadOnNotification(cancelDownloadOnNotification: Boolean): AppUpdater.Builder

是否支持通过删除通知栏来取消下载（默认为：false）

fun setChannelId(channelId: String): AppUpdater.Builder

设置通知通道ID

fun setChannelName(channelName: String): AppUpdater.Builder

设置通知通道名称

setDeleteFileOnCancel

fun setDeleteFileOnCancel(deleteFileOnCancel: Boolean): AppUpdater.Builder

设置是否自动删除取消下载的文件

setDownloadListener

fun setDownloadListener(listener: DownloadListener?): AppUpdater.Builder

设置下载监听

fun setFilename(filename: String): AppUpdater.Builder

设置保存的文件名

fun setHttpManager(httpManager: IHttpManager): AppUpdater.Builder

设置HTTP管理器

fun setInstallApk(installApk: Boolean): AppUpdater.Builder

设置下载完成后是否自动请求安装APK

setMaxRetryCount

fun setMaxRetryCount(maxRetryCount: Int): AppUpdater.Builder

设置下载失败时，最多重新下载次数。与之相关联的方法setRetryOnNotification

setNotificationHandler

fun setNotificationHandler(notificationHandler: INotificationHandler): AppUpdater.Builder

设置通知栏处理器

setNotificationIcon

fun setNotificationIcon(@DrawableRes notificationIcon: Int): AppUpdater.Builder

设置通知图标

setNotificationId

fun setNotificationId(notificationId: Int): AppUpdater.Builder

设置通知ID

setRetryOnNotification

fun setRetryOnNotification(retryOnNotification: Boolean): AppUpdater.Builder

设置下载失败时，是否支持点击通知栏重新下载。与之相关联的方法setMaxRetryCount

setShowNotification

fun setShowNotification(isShowNotification: Boolean): AppUpdater.Builder

设置是否显示通知栏

setShowPercentage

fun setShowPercentage(showPercentage: Boolean): AppUpdater.Builder

设置下载时，通知栏是否显示下载百分比

fun setSound(sound: Boolean): AppUpdater.Builder

设置通知是否铃声提示

fun setUrl(url: String): AppUpdater.Builder

设置APK下载地址

fun setVersionCode(versionCode: Int): AppUpdater.Builder

设置要下载APK的versionCode，用于优先取缓存时通过versionCode校验APK文件是否一致。缓存校验目前支持两种方式，一种是通过versionCode校验，对应方法：setVersionCode；一种是文件MD5校验，对应方法：setApkMd5。推荐使用MD5校验方式如果两种方式都设置了，则只校验MD5

fun setVibrate(vibrate: Boolean): AppUpdater.Builder

设置通知是否震动提示