CancellationSignal

class CancellationSignal
Content copied to clipboard

Cancellation object for the UnitController.openLiveData method. Calling cancel on this object will attempt to cancel the open operation. If the cancellation was successful the Response.Status will be Response.Status.FAIL and Response.exception will be the exception object passed to the cancel method.

Constructors

CancellationSignal
Link copied to clipboard
fun CancellationSignal()
Content copied to clipboard

Functions

cancel
Link copied to clipboard
fun cancel(exception: Exception = CanceledException())
Content copied to clipboard

Attempts to cancel the open operation this object was passed to. This method has a default CanceledException parameter. Custom Exception classes can be used to signal the reason for canceling the operation.