ControllableTask

public abstract class ControllableTask extends CancellableTask
Known direct subclasses
StorageTask

A controllable Task that has a synchronized state machine.

Known indirect subclasses
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

the type of state this operation returns in events.

Summary

Public constructors

Public methods

abstract @NonNull ControllableTask

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

abstract @NonNull ControllableTask
addOnPausedListener(
    @NonNull Activity activity,
    @NonNull OnPausedListener<Object> listener
)

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

abstract @NonNull ControllableTask
addOnPausedListener(
    @NonNull Executor executor,
    @NonNull OnPausedListener<Object> listener
)

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

abstract boolean
abstract boolean

Attempts to pause the task.

abstract boolean

Attempts to resume this task.

Inherited methods

From com.google.firebase.storage.CancellableTask
abstract @NonNull CancellableTask

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

abstract @NonNull CancellableTask
addOnProgressListener(
    @NonNull Activity activity,
    @NonNull OnProgressListener<Object> listener
)

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

abstract @NonNull CancellableTask
addOnProgressListener(
    @NonNull Executor executor,
    @NonNull OnProgressListener<Object> listener
)

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

abstract boolean

Attempts to cancel the task.

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

Public constructors

ControllableTask

public ControllableTask()

Public methods

addOnPausedListener

public abstract @NonNull ControllableTask addOnPausedListener(@NonNull OnPausedListener<Object> listener)

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

Returns
@NonNull ControllableTask

this Task

addOnPausedListener

public abstract @NonNull ControllableTask addOnPausedListener(
    @NonNull Activity activity,
    @NonNull OnPausedListener<Object> listener
)

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

Parameters
@NonNull Activity activity

When the supplied Activity stops, this listener will automatically be removed.

Returns
@NonNull ControllableTask

this Task

addOnPausedListener

public abstract @NonNull ControllableTask addOnPausedListener(
    @NonNull Executor executor,
    @NonNull OnPausedListener<Object> listener
)

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

Parameters
@NonNull Executor executor

the executor to use to call the listener

Returns
@NonNull ControllableTask

this Task

isPaused

public abstract boolean isPaused()
Returns
boolean

true if the task has been paused.

pause

public abstract boolean pause()

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

public abstract boolean resume()

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.