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.

ControllableTask

abstract class ControllableTask<StateT> : CancellableTask

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

Known direct subclasses

StorageTask

StorageTask

A controllable Task that has a synchronized state machine.

Known indirect subclasses

FileDownloadTask, StreamDownloadTask, UploadTask

`FileDownloadTask`	A task that downloads bytes of a GCS blob to a specified File.
`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 paused, resumed and canceled. This task also receives progress and other state change notifications.

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

Summary

Public constructors
`ControllableTask()`

Public functions
`abstract ControllableTask<StateT!>`	`addOnPausedListener(listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.
`abstract ControllableTask<StateT!>`	`addOnPausedListener(activity: Activity, listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.
`abstract ControllableTask<StateT!>`	`addOnPausedListener(executor: Executor, listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.
`abstract Boolean`	`isPaused()`
`abstract Boolean`	`pause()` Attempts to pause the task.
`abstract Boolean`	`resume()` Attempts to resume this task.

Inherited functions

From com.google.firebase.storage.CancellableTask

`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()`

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`	`isCanceled()`
`abstract Boolean`	`isComplete()`
`abstract Boolean`	`isSuccessful()`
`Task<TContinuationResult!>!`	`<TContinuationResult> onSuccessTask( p: SuccessContinuation<TResult!, TContinuationResult!>! )`

Public constructors

ControllableTask

ControllableTask()

Public functions

addOnPausedListener

abstract fun addOnPausedListener(listener: OnPausedListener<Any!>): ControllableTask<StateT!>

Adds a listener that is called when the Task becomes paused.

Returns
`ControllableTask<StateT!>`	this Task

addOnPausedListener

abstract fun addOnPausedListener(activity: Activity, listener: OnPausedListener<Any!>): ControllableTask<StateT!>

Adds a listener that is called when the Task becomes paused.

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

Returns
`ControllableTask<StateT!>`	this Task

addOnPausedListener

abstract fun addOnPausedListener(executor: Executor, listener: OnPausedListener<Any!>): ControllableTask<StateT!>

Adds a listener that is called when the Task becomes paused.

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

Returns
`ControllableTask<StateT!>`	this Task

isPaused

abstract fun isPaused(): Boolean

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

pause

abstract fun pause(): Boolean

Attempts to pause the task. A paused task can later be resumed.

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

resume

abstract fun resume(): Boolean

Attempts to resume this task.

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