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 youmigrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

UploadTask

classUploadTask :StorageTask

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

An controllable task that uploads and fires events for success, progress and failure. It also allows pause and resume to control the upload operation.

Summary

Nested types
`classUploadTask.TaskSnapshot :StorageTask.SnapshotBase` Encapsulates state about the running`UploadTask`

Protected functions
`Unit`	`onCanceled()`
`Unit`	`resetState()`

Inherited functions

Fromcom.google.firebase.storage.CancellableTask

`abstractCancellableTask<StateT!>`	`addOnProgressListener(listener: OnProgressListener<Any!>)` Adds a listener that is called periodically while the ControllableTask executes.
`abstractCancellableTask<StateT!>`	`addOnProgressListener( activity: Activity, listener: OnProgressListener<Any!> )` Adds a listener that is called periodically while the ControllableTask executes.
`abstractCancellableTask<StateT!>`	`addOnProgressListener( executor: Executor, listener: OnProgressListener<Any!> )` Adds a listener that is called periodically while the ControllableTask executes.

Fromcom.google.firebase.storage.ControllableTask

`abstractControllableTask<StateT!>`	`addOnPausedListener(listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.
`abstractControllableTask<StateT!>`	`addOnPausedListener(activity: Activity, listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.
`abstractControllableTask<StateT!>`	`addOnPausedListener(executor: Executor, listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.

Fromcom.google.firebase.storage.StorageTask

`StorageTask<ResultT!>`	`addOnCanceledListener(listener: OnCanceledListener)` Adds a listener that is called if the Task is canceled.
`StorageTask<ResultT!>`	`addOnCanceledListener(activity: Activity, listener: OnCanceledListener)` Adds an Activity-scoped listener that is called if the Task is canceled.
`StorageTask<ResultT!>`	`addOnCanceledListener(executor: Executor, listener: OnCanceledListener)` Adds a listener that is called if the Task is canceled.
`StorageTask<ResultT!>`	`addOnCompleteListener(listener: OnCompleteListener<ResultT!>)` Adds a listener that is called when the Task succeeds or fails.
`StorageTask<ResultT!>`	`addOnCompleteListener( activity: Activity, listener: OnCompleteListener<ResultT!> )` Adds a listener that is called when the Task succeeds or fails.
`StorageTask<ResultT!>`	`addOnCompleteListener( executor: Executor, listener: OnCompleteListener<ResultT!> )` Adds a listener that is called when the Task succeeds or fails.
`StorageTask<ResultT!>`	`addOnFailureListener(listener: OnFailureListener)` Adds a listener that is called if the Task fails.
`StorageTask<ResultT!>`	`addOnFailureListener(activity: Activity, listener: OnFailureListener)` Adds a listener that is called if the Task fails.
`StorageTask<ResultT!>`	`addOnFailureListener(executor: Executor, listener: OnFailureListener)` Adds a listener that is called if the Task fails.
`StorageTask<ResultT!>`	`addOnPausedListener(listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.
`StorageTask<ResultT!>`	`addOnPausedListener(activity: Activity, listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.
`StorageTask<ResultT!>`	`addOnPausedListener(executor: Executor, listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.
`StorageTask<ResultT!>`	`addOnProgressListener(listener: OnProgressListener<Any!>)` Adds a listener that is called periodically while the ControllableTask executes.
`StorageTask<ResultT!>`	`addOnProgressListener( activity: Activity, listener: OnProgressListener<Any!> )` Adds a listener that is called periodically while the ControllableTask executes.
`StorageTask<ResultT!>`	`addOnProgressListener( executor: Executor, listener: OnProgressListener<Any!> )` Adds a listener that is called periodically while the ControllableTask executes.
`StorageTask<ResultT!>`	`addOnSuccessListener(listener: OnSuccessListener<Any!>)` Adds a listener that is called if the Task completes successfully.
`StorageTask<ResultT!>`	`addOnSuccessListener( activity: Activity, listener: OnSuccessListener<Any!> )` Adds a listener that is called if the Task completes successfully.
`StorageTask<ResultT!>`	`addOnSuccessListener( executor: Executor, listener: OnSuccessListener<Any!> )` Adds a listener that is called if the Task completes successfully.
`Boolean`	`cancel()` Attempts to cancel the task.
`Task<ContinuationResultT!>`	`<ContinuationResultT>continueWith( continuation: Continuation<ResultT!, ContinuationResultT!> )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`Task<ContinuationResultT!>`	`<ContinuationResultT>continueWith( executor: Executor, continuation: Continuation<ResultT!, ContinuationResultT!> )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`Task<ContinuationResultT!>`	`<ContinuationResultT>continueWithTask( continuation: Continuation<ResultT!, Task<ContinuationResultT!>!> )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`Task<ContinuationResultT!>`	`<ContinuationResultT>continueWithTask( executor: Executor, continuation: Continuation<ResultT!, Task<ContinuationResultT!>!> )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`Exception?`	`getException()` Returns the exception that caused the Task to fail.
`ResultT`	`getResult()` Gets the result of the Task, if it has already completed.
`ResultT`	`<X : Throwable?>getResult(exceptionType: Class<X!>)` Gets the result of the Task, if it has already completed.
`ResultT`	`getSnapshot()` Returns the current state of the task.
`Boolean`	`isCanceled()` Returns`true` if the task has been canceled.
`Boolean`	`isComplete()` Returns`true` if the Task is complete;`false` otherwise.
`Boolean`	`isInProgress()` Returns`true` if the task is currently running.
`Boolean`	`isPaused()` Returns`true` if the task has been paused.
`Boolean`	`isSuccessful()` Returns`true` if the Task has completed successfully;`false` otherwise.
`Unit`	`onFailure()`
`Unit`	`onPaused()`
`Unit`	`onProgress()`
`Unit`	`onQueued()`
`Unit`	`onSuccess()`
`Task<ContinuationResultT!>`	`<ContinuationResultT>onSuccessTask( continuation: SuccessContinuation<ResultT!, ContinuationResultT!> )` Returns a new Task that will be completed with the result of applying the specified SuccessContinuation to this Task when this Task completes successfully.
`Task<ContinuationResultT!>`	`<ContinuationResultT>onSuccessTask( executor: Executor, continuation: SuccessContinuation<ResultT!, ContinuationResultT!> )` Returns a new Task that will be completed with the result of applying the specified SuccessContinuation to this Task when this Task completes successfully.
`Boolean`	`pause()` Attempts to pause the task.
`StorageTask<ResultT!>`	`removeOnCanceledListener(listener: OnCanceledListener)` Removes a listener.
`StorageTask<ResultT!>`	`removeOnCompleteListener(listener: OnCompleteListener<ResultT!>)` Removes a listener.
`StorageTask<ResultT!>`	`removeOnFailureListener(listener: OnFailureListener)` Removes a listener.
`StorageTask<ResultT!>`	`removeOnPausedListener(listener: OnPausedListener<Any!>)` Removes a listener.
`StorageTask<ResultT!>`	`removeOnProgressListener(listener: OnProgressListener<Any!>)` Removes a listener.
`StorageTask<ResultT!>`	`removeOnSuccessListener(listener: OnSuccessListener<Any!>)` Removes a listener.
`Boolean`	`resume()` Attempts to resume a paused task.

Fromcom.google.android.gms.tasks.Task

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

Inherited properties

Fromcom.google.firebase.storage.StorageTask

Any!

syncObject

Protected functions

onCanceled

protected fun onCanceled(): Unit

resetState

protected fun resetState(): Unit

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-21 UTC.

Movatterモバイル変換

UploadTask

Summary

Nested types

Protected functions

Inherited functions

Inherited properties

Protected functions

onCanceled

resetState