ResultCallbacks

abstract class ResultCallbacks<R : Result?> : ResultCallback

Known direct subclasses
ResolvingResultCallbacks

ResultCallbacks which automatically start resolutions for failures.


Callbacks for receiving a Result from a as an asynchronous callback. Contains separate callbacks for success and failure.

These methods are called on the main thread, unless overridden by setHandler.

Summary

Public constructors

Public functions

abstract Unit
onFailure(result: Status)

Called when the Result is ready and a failure occurred.

abstract Unit
onSuccess(result: R)

Called when the Result is ready and was successful.

Public constructors

ResultCallbacks

ResultCallbacks()

Public functions

onFailure

abstract fun onFailure(result: Status): Unit

Called when the Result is ready and a failure occurred.

Parameters
result: Status

Status resulting from the API call. Guaranteed to be non-null and unsuccessful.

onSuccess

abstract fun onSuccess(result: R): Unit

Called when the Result is ready and was successful.

It is the responsibility of the callback to release any resources associated with the result if onSuccess is called. Some result types may implement Releasable, in which case release should be used to free the associated resources. If a failure occurs the result will be released automatically.

Parameters
result: R

The result from the API call. Never null.