Added in API level 1

CountDownTimer


abstract class CountDownTimer
kotlin.Any
   ↳ android.os.CountDownTimer

Schedule a countdown until a time in the future, with regular notifications on intervals along the way. Example of showing a 30 second countdown in a text field:

Kotlin

object : CountDownTimer(30000, 1000) {
 
      override fun onTick(millisUntilFinished: Long) {
          mTextField.setText("seconds remaining: " + millisUntilFinished / 1000)
      }
 
      override fun onFinish() {
          mTextField.setText("done!")
      }
  }.start()
  

Java

new CountDownTimer(30000, 1000) {
 
      public void onTick(long millisUntilFinished) {
          mTextField.setText("seconds remaining: " + millisUntilFinished / 1000);
      }
 
      public void onFinish() {
          mTextField.setText("done!");
      }
  }.start();
  

The calls to onTick(long) are synchronized to this object so that one call to onTick(long) won't ever occur before the previous callback is complete. This is only relevant when the implementation of onTick(long) takes an amount of time to execute that is significant compared to the countdown interval.

Summary

Public constructors
CountDownTimer(millisInFuture: Long, countDownInterval: Long)

Public methods
Unit

Cancel the countdown.

abstract Unit

Callback fired when the time is up.

abstract Unit
onTick(millisUntilFinished: Long)

Callback fired on regular interval.

CountDownTimer!

Start the countdown.

Public constructors

CountDownTimer

Added in API level 1
CountDownTimer(
    millisInFuture: Long,
    countDownInterval: Long)
Parameters
millisInFuture Long: The number of millis in the future from the call to start() until the countdown is done and onFinish() is called.
countDownInterval Long: The interval along the way to receive onTick(long) callbacks.

Public methods

cancel

Added in API level 1
fun cancel(): Unit

Cancel the countdown.

onFinish

Added in API level 1
abstract fun onFinish(): Unit

Callback fired when the time is up.

onTick

Added in API level 1
abstract fun onTick(millisUntilFinished: Long): Unit

Callback fired on regular interval.

Parameters
millisUntilFinished Long: The amount of time until finished.

start

Added in API level 1
fun start(): CountDownTimer!

Start the countdown.