CancellationSignal

public CancellationSignal()

Creates a cancellation signal, initially not canceled.

public void cancel()

Cancels the operation and signals the cancellation listener. If the operation has not yet started, then it will be canceled as soon as it does.

public @Nullable Object getCancellationSignalObject()

Gets the framework android.os.CancellationSignal associated with this object.

Framework support for cancellation signals was added in JELLY_BEAN so this method will always return null on older versions of the platform.

public boolean isCanceled()

Returns true if the operation has been canceled.

public void setOnCancelListener(
    @Nullable CancellationSignal.OnCancelListener listener
)

Sets the cancellation listener to be called when canceled. This method is intended to be used by the recipient of a cancellation signal such as a database or a content provider to handle cancellation requests while performing a long-running operation. This method is not intended to be used by applications themselves. If cancel has already been called, then the provided listener is invoked immediately. This method is guaranteed that the listener will not be called after it has been removed.

public void throwIfCanceled()

Throws OperationCanceledException if the operation has been canceled.