IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

CancellableTask

abstract class CancellableTask<StateT> : Task

kotlin.Any
↳	com.google.android.gms.tasks.Task
	↳	com.google.firebase.storage.CancellableTask

Known direct subclasses

ControllableTask

ControllableTask

Represents an asynchronous operation that can be paused, resumed and canceled.

Known indirect subclasses

FileDownloadTask, StorageTask, StreamDownloadTask, UploadTask

`FileDownloadTask`	A task that downloads bytes of a GCS blob to a specified File.
`StorageTask`	A controllable Task that has a synchronized state machine.
`StreamDownloadTask`	A task that downloads bytes of a GCS blob.
`UploadTask`	An controllable task that uploads and fires events for success, progress and failure.

Represents an asynchronous operation that can be canceled.

Parameters
`<StateT>`	the type of state this operation returns in events.

Summary

Public constructors
`CancellableTask()`

Public functions
`abstract CancellableTask<StateT!>`	`addOnProgressListener(listener: OnProgressListener<Any!>)` Adds a listener that is called periodically while the ControllableTask executes.
`abstract CancellableTask<StateT!>`	`addOnProgressListener( activity: Activity, listener: OnProgressListener<Any!> )` Adds a listener that is called periodically while the ControllableTask executes.
`abstract CancellableTask<StateT!>`	`addOnProgressListener( executor: Executor, listener: OnProgressListener<Any!> )` Adds a listener that is called periodically while the ControllableTask executes.
`abstract Boolean`	`cancel()` Attempts to cancel the task.
`abstract Boolean`	`isCanceled()`
`abstract Boolean`	`isInProgress()`

Inherited functions

From com.google.android.gms.tasks.Task

`Task<TResult!>!`	`addOnCanceledListener(p: OnCanceledListener!)`
`Task<TResult!>!`	`addOnCompleteListener(p: OnCompleteListener<TResult!>!)`
`abstract Task<TResult!>!`	`addOnFailureListener(p: OnFailureListener!)`
`abstract Task<TResult!>!`	`addOnSuccessListener(p: OnSuccessListener<Any!>!)`
`Task<TContinuationResult!>!`	`<TContinuationResult> continueWith( p: Continuation<TResult!, TContinuationResult!>! )`
`Task<TContinuationResult!>!`	`<TContinuationResult> continueWithTask( p: Continuation<TResult!, Task<TContinuationResult!>!>! )`
`abstract Exception!`	`getException()`
`abstract TResult!`	`getResult()`
`abstract Boolean`	`isComplete()`
`abstract Boolean`	`isSuccessful()`
`Task<TContinuationResult!>!`	`<TContinuationResult> onSuccessTask( p: SuccessContinuation<TResult!, TContinuationResult!>! )`

Public constructors

CancellableTask

CancellableTask()

Public functions

addOnProgressListener

abstract fun addOnProgressListener(listener: OnProgressListener<Any!>): CancellableTask<StateT!>

Adds a listener that is called periodically while the ControllableTask executes.

Returns
`CancellableTask<StateT!>`	this Task

addOnProgressListener

abstract fun addOnProgressListener(
    activity: Activity,
    listener: OnProgressListener<Any!>
): CancellableTask<StateT!>

Adds a listener that is called periodically while the ControllableTask executes.

Parameters
`activity: Activity`	When the supplied `Activity` stops, this listener will automatically be removed.

Returns
`CancellableTask<StateT!>`	this Task

addOnProgressListener

abstract fun addOnProgressListener(
    executor: Executor,
    listener: OnProgressListener<Any!>
): CancellableTask<StateT!>

Adds a listener that is called periodically while the ControllableTask executes.

Parameters
`executor: Executor`	the executor to use to call the listener

Returns
`CancellableTask<StateT!>`	this Task

cancel

abstract fun cancel(): Boolean

Attempts to cancel the task. A canceled task cannot be resumed later. A canceled task calls back on listeners subscribed to addOnFailureListener with an exception that indicates the task was canceled.

Returns
`Boolean`	true if this task was successfully canceled or is in the process of being canceled. Returns false if the task is already completed or in a state that cannot be canceled.

isCanceled

abstract fun isCanceled(): Boolean

Returns
`Boolean`	true if the task has been canceled.

isInProgress

abstract fun isInProgress(): Boolean

Returns
`Boolean`	true if the task is currently running.