Interval

open class Interval @JvmOverloads() constructor(end: Long, period: Long, unit: TimeUnit, start: Long, initialDelay: Long) : Serializable, Closeable

创建一个轮询器

操作

开启 start 只有在闲置状态下才可以开始
停止 stop
暂停 pause
继续 resume
重置 reset 重置不会导致轮询器停止
开关 switch 开启|暂停切换
生命周期 life

函数回调: 允许多次订阅同一个轮询器

每个事件 subscribe
停止或者结束 finish

Parameters

end

结束值, -1 表示永远不结束

period

计时器间隔

unit

计时器单位

initialDelay

第一次事件的间隔时间, 默认0

start

开始值, 当start]比end值大, 且end不等于-1时, 即为倒计时, 反之正计时

Constructors

Interval

@JvmOverloads()

fun Interval(period: Long, unit: TimeUnit, initialDelay: Long = 0)

创建一个不会自动结束的轮询器/计时器

Interval

@JvmOverloads()

fun Interval(end: Long, period: Long, unit: TimeUnit, start: Long = 0, initialDelay: Long = 0)

结束值, -1 表示永远不结束

Functions

cancel

fun cancel()

取消区别于stop并不会执行finish

open override fun close()

等于cancel

finish

fun finish(block: Interval.(Long) -> Unit): <ERROR CLASS>

轮询器完成时回调该函数

life

@JvmOverloads()

fun life(fragment: Fragment, lifeEvent: Lifecycle.Event = Lifecycle.Event.ON_DESTROY): Interval

自动在指定生命周期后取消cancel轮询器

@JvmOverloads()

fun life(lifecycleOwner: LifecycleOwner, lifeEvent: Lifecycle.Event = Lifecycle.Event.ON_DESTROY): <ERROR CLASS>

自动在指定生命周期后取消cancel轮询器

onlyResumed

fun onlyResumed(lifecycleOwner: LifecycleOwner): <ERROR CLASS>

当界面不可见时暂停pause, 当界面可见时继续resume, 当界面销毁时cancel轮询器

pause

fun pause()

暂停

reset

fun reset()

重置

resume

fun resume()

继续要求轮询器为暂停状态IntervalStatus.STATE_PAUSE, 否则无效

start

fun start(): <ERROR CLASS>

开始如果当前为暂停状态将重新开始轮询

stop

fun stop()

停止

fun subscribe(block: Interval.(Long) -> Unit): <ERROR CLASS>

订阅轮询器每次轮询器计时都会调用该回调函数轮询器完成时会同时触发回调block和finish

switch

fun switch()

切换轮询器开始或结束假设轮询器为暂停IntervalStatus.STATE_PAUSE状态将继续运行resume

Properties

count

var count: Long

轮询器的计数

end

var end: Long

结束值, -1 表示永远不结束

state

var state: IntervalStatus

轮询器当前状态

Extensions

life

fun Interval.life(viewModel: ViewModel): <ERROR CLASS>

轮询器根据ViewModel生命周期自动取消