Gio.SimpleAsyncResult.prototype.set_check_cancellable

function set_check_cancellable(check_cancellable: Gio.Cancellable): void {
    // Gjs wrapper for g_simple_async_result_set_check_cancellable()
}
  

Sets a Gio.Cancellable to check before dispatching results.

This function has one very specific purpose: the provided cancellable is checked at the time of Gio.SimpleAsyncResult.prototype.propagate_error If it is cancelled, these functions will return an "Operation was cancelled" error (Gio.IOErrorEnum.cancelled).

Implementors of cancellable asynchronous functions should use this in order to provide a guarantee to their callers that cancelling an async operation will reliably result in an error being returned for that operation (even if a positive result for the operation has already been sent as an idle to the main context to be dispatched).

The checking described above is done regardless of any call to the unrelated Gio.SimpleAsyncResult.prototype.set_handle_cancellation function.

Since 2.32