CancellationSignal
class CancellationSignal
Static library support version of the framework's android.os.CancellationSignal. Used to write apps that run on platforms prior to Android 4.1. See the framework SDK documentation for a class overview.
Summary
Nested types |
|---|
interface CancellationSignal.OnCancelListenerListens for cancellation. |
Public constructors |
|---|
|
Creates a cancellation signal, initially not canceled. |
Public functions |
|
|---|---|
Unit |
cancel()Cancels the operation and signals the cancellation listener. |
Any? |
Gets the framework |
Boolean |
Returns true if the operation has been canceled. |
Unit |
Sets the cancellation listener to be called when canceled. |
Unit |
Throws |
Public constructors
Public functions
fun cancel(): Unit
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.
fun getCancellationSignalObject(): Any?
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.
| Returns | |
|---|---|
Any? |
A framework cancellation signal object, or null on platform versions prior to Jellybean. |
fun isCanceled(): Boolean
Returns true if the operation has been canceled.
| Returns | |
|---|---|
Boolean |
True if the operation has been canceled. |
fun setOnCancelListener(listener: CancellationSignal.OnCancelListener?): Unit
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.
| Parameters | |
|---|---|
listener: CancellationSignal.OnCancelListener? |
The cancellation listener, or null to remove the current listener. |
fun throwIfCanceled(): Unit
Throws OperationCanceledException if the operation has been canceled.
| Throws | |
|---|---|
androidx.core.os.OperationCanceledException |
if the operation has been canceled. |