LoaderManager

LoaderManager()

@MainThread
abstract fun destroyLoader(id: Int): Unit

Stops and removes the loader with the given ID. If this loader had previously reported data to the client through onLoadFinished, a call will be made to onLoaderReset.

Must be called from the process's main thread.

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

Print the LoaderManager's state into the given stream.

java-static fun enableDebugLogging(enabled: Boolean): Unit

Control whether the framework's internal loader manager debugging logs are turned on. If enabled, you will see output in logcat as the framework performs loader operations.

java-static fun <T : LifecycleOwner? & ViewModelStoreOwner?> getInstance(owner: T): LoaderManager

Gets a LoaderManager associated with the given owner, such as a androidx.fragment.app.FragmentActivity or androidx.fragment.app.Fragment.

abstract fun <D> getLoader(id: Int): Loader<D!>?

Return the Loader with the given id or null if no matching Loader is found.

fun hasRunningLoaders(): Boolean

Returns true if any loaders managed are currently running and have not returned data to the application yet.

@MainThread
abstract fun <D> initLoader(
    id: Int,
    args: Bundle?,
    callback: LoaderManager.LoaderCallbacks<D!>
): Loader<D!>

Ensures a loader is initialized and active. If the loader doesn't already exist, one is created and (if the activity/fragment is currently started) starts the loader. Otherwise the last created loader is re-used.

In either case, the given callback is associated with the loader, and will be called as the loader state changes. If at the point of call the caller is in its started state, and the requested loader already exists and has generated its data, then callback onLoadFinished will be called immediately (inside of this function), so you must be prepared for this to happen.

Must be called from the process's main thread.

abstract fun markForRedelivery(): Unit

Mark all Loaders associated with this LoaderManager for redelivery of their current data (if any), waiting for the next time the Loader is started if it is currently stopped. In cases where no data has yet been delivered, this is effectively a no-op. In cases where data has already been delivered via onLoadFinished, this will ensure that onLoadFinished is called again with the same data.

Call this only if you are implementing a LifecycleOwner where the views/elements that developers are likely to use in onLoadFinished can be created and destroyed multiple times without the LifecycleOwner itself being destroyed. Call this when the views/elements are being destroyed to ensure that the data is redelivered upon recreation.

@MainThread
abstract fun <D> restartLoader(
    id: Int,
    args: Bundle?,
    callback: LoaderManager.LoaderCallbacks<D!>
): Loader<D!>

Starts a new or restarts an existing android.content.Loader in this manager, registers the callbacks to it, and (if the activity/fragment is currently started) starts loading it. If a loader with the same id has previously been started it will automatically be destroyed when the new loader completes its work. The callback will be delivered before the old loader is destroyed.

Must be called from the process's main thread.