BaseRequest

abstract class BaseRequest

Functions

addDownloadListener

fun addDownloadListener(progressListener: ProgressListener)

下载监听器

addHeader

fun addHeader(name: String, value: String)

添加请求头如果已存在相同name的请求头会添加而不会覆盖, 因为请求头本身存在多个值

buildRequest

open fun buildRequest(): Request

构建请求对象Request

enqueue

fun enqueue(block: Callback): Call

队列请求.

execute

inline fun <R> execute(): R

执行同步请求

onResult

inline fun <R> onResult(crossinline block: Result<R>.() -> Unit): Call

队列请求.

param

abstract fun param(name: String, value: Boolean?)

基础类型表单参数如果当前请求为Url请求则为Query参数如果当前请求为表单请求则为表单参数如果当前为Multipart包含流/文件的请求则为multipart参数

abstract fun param(name: String, value: Number?)

基础类型表单参数如果当前请求为Url请求则为Query参数如果当前请求为表单请求则为表单参数如果当前为Multipart包含流/文件的请求则为multipart参数

abstract fun param(name: String, value: String?)

基础类型表单参数如果当前请求为Url请求则为Query参数如果当前请求为表单请求则为表单参数如果当前为Multipart包含流/文件的请求则为multipart参数

abstract fun param(name: String, value: String?, encoded: Boolean)

基础类型表单参数如果当前请求为Url请求则为Query参数如果当前请求为表单请求则为表单参数如果当前为Multipart包含流/文件的请求则为multipart参数

removeHeader

fun removeHeader(name: String)

删除请求头

setCacheControl

fun setCacheControl(cacheControl: CacheControl)

设置请求头的缓存控制

setClient

fun setClient(block: OkHttpClient.Builder.() -> Unit)

修改当前Request的OkHttpClient配置, 不会影响全局默认的OkHttpClient

setDownloadDir

fun setDownloadDir(name: File?)

fun setDownloadDir(name: String?)

下载文件的保存目录

setDownloadFileName

fun setDownloadFileName(name: String?)

下载文件名

setDownloadFileNameConflict

fun setDownloadFileNameConflict(enabled: Boolean = true)

假设下载文件路径已存在同名文件是否重命名, 例如file_name(1).apk

setDownloadFileNameDecode

fun setDownloadFileNameDecode(enabled: Boolean = true)

文件名称是否使用URL解码例如下载的文件名如果是中文, 服务器传输给你的会是被URL编码的字符串.

setDownloadMd5Verify

fun setDownloadMd5Verify(enabled: Boolean = true)

如果服务器返回 "Content-MD5"响应头和制定路径已经存在的文件MD5相同是否直接返回File

setDownloadTempFile

fun setDownloadTempFile(enabled: Boolean = true)

下载是否使用临时文件避免下载失败后覆盖同名文件或者无法判别是否已下载完整, 仅在下载完整以后才会显示为原有文件名临时文件命名规则: 文件名 + .net-download 下载文件名: install.apk, 临时文件名: install.apk.

setGroup

fun setGroup(group: Any?)

分组

setHeader

fun setHeader(name: String, value: String)

设置请求头, 会覆盖请求头而不像addHeader是添加

setHeaders

fun setHeaders(headers: Headers)

批量设置请求头

setId

fun setId(id: Any?)

唯一的Id

setKType

inline fun <T> setKType()

为请求附着针对Kotlin的Type信息

setLabel

inline fun <T> setLabel(tag: T?)

使用T作为键名添加标签使用Request.

setLogRecord

fun setLogRecord(enabled: Boolean)

是否启用日志记录器

setPath

fun setPath(path: String?)

解析配置Path, 支持识别query参数和绝对路径

setQuery

fun setQuery(name: String, value: String?, encoded: Boolean = false)

设置Url上的Query参数

setTag

fun setTag(tag: Any?)

使用Any::class作为键名添加标签使用Request.

fun <T> setTag(type: Class<in T>, tag: T?)

使用type作为键名添加标签使用Request.

fun setTag(name: String, tag: Any?)

添加标签使用Request.tag(name)得到指定标签

setUrl

open fun setUrl(url: URL)

设置Url

open fun setUrl(url: String)

设置一个Url字符串, 其参数不会和你初始化时设置的主域名NetConfig.host进行拼接一般情况下我建议使用更为聪明的setPath

open fun setUrl(url: HttpUrl)

设置Url

toResult

inline fun <R> toResult(): Result<R>

执行同步请求

Properties

converter

open var converter: NetConverter

当前请求的数据转换器

httpUrl

open var httpUrl: HttpUrl.Builder

请求的Url构造器

method

open var method: Method

请求的方法

okHttpClient

open var okHttpClient: OkHttpClient

请求客户端

okHttpRequest

open var okHttpRequest: Request.Builder

请求对象构造器

Inheritors

BodyRequest

UrlRequest