AsyncTaskLoader

abstract class AsyncTaskLoader<D : Any!> : Loader<D>
kotlin.Any
   ↳ androidx.loader.content.Loader<D>
   ↳ androidx.loader.content.AsyncTaskLoader

Static library support version of the framework's android.content.AsyncTaskLoader. Used to write apps that run on platforms prior to Android 3.0. When running on Android 3.0 or above, this implementation is still used; it does not try to switch to the framework's implementation. See the framework SDK documentation for a class overview.

Summary

Public constructors
<init>(context: Context)

Public methods
open Boolean

Returns true if the current invocation of #loadInBackground is being canceled.

open Unit

Set amount to throttle updates by.

abstract D?

Called on a worker thread to perform the actual load and to return the result of the load operation.

open Unit

Called on the main thread to abort a load in progress.

open Unit
dump(prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!)

open Unit
onCanceled(data: D?)

Called if the task was canceled before it was completed.

Protected methods
open D?

Calls #loadInBackground().

open Boolean

open Unit

Inherited functions

Public constructors

<init>

AsyncTaskLoader(context: Context)

Public methods

isLoadInBackgroundCanceled

open fun isLoadInBackgroundCanceled(): Boolean

Returns true if the current invocation of #loadInBackground is being canceled.

Return
Boolean: True if the current invocation of #loadInBackground is being canceled.

setUpdateThrottle

open fun setUpdateThrottle(delayMS: Long): Unit

Set amount to throttle updates by. This is the minimum time from when the last #loadInBackground() call has completed until a new load is scheduled.

Parameters
delayMS Long: Amount of delay, in milliseconds.

loadInBackground

abstract fun loadInBackground(): D?

Called on a worker thread to perform the actual load and to return the result of the load operation. Implementations should not deliver the result directly, but should return them from this method, which will eventually end up calling #deliverResult on the UI thread. If implementations need to process the results on the UI thread they may override #deliverResult and do so there. To support cancellation, this method should periodically check the value of #isLoadInBackgroundCanceled and terminate when it returns true. Subclasses may also override #cancelLoadInBackground to interrupt the load directly instead of polling #isLoadInBackgroundCanceled. When the load is canceled, this method may either return normally or throw OperationCanceledException. In either case, the Loader will call #onCanceled to perform post-cancellation cleanup and to dispose of the result object, if any.

Return
D?: The result of the load operation.
Exceptions
OperationCanceledException if the load is canceled during execution.

cancelLoadInBackground

open fun cancelLoadInBackground(): Unit

Called on the main thread to abort a load in progress. Override this method to abort the current invocation of #loadInBackground that is running in the background on a worker thread. This method should do nothing if #loadInBackground has not started running or if it has already finished.

dump

open fun 
        dump
(prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!): Unit

Deprecated:

onCanceled

open fun onCanceled(data: D?): Unit

Called if the task was canceled before it was completed. Gives the class a chance to clean up post-cancellation and to properly dispose of the result.

Parameters
data D?: The value that was returned by #loadInBackground, or null if the task threw OperationCanceledException.

Protected methods

onLoadInBackground

protected open fun onLoadInBackground(): D?

Calls #loadInBackground(). This method is reserved for use by the loader framework. Subclasses should override #loadInBackground instead of this method.

Return
D?: The result of the load operation.
Exceptions
OperationCanceledException if the load is canceled during execution.

onCancelLoad

protected open fun onCancelLoad(): Boolean

onForceLoad

protected open fun onForceLoad(): Unit