CursorLoader Class

Definition

Namespace:: Android.Content

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A loader that queries the ContentResolver and returns a Cursor.

[Android.Runtime.Register("android/content/CursorLoader", DoNotGenerateAcw=true)]
public class CursorLoader : Android.Content.AsyncTaskLoader

[<Android.Runtime.Register("android/content/CursorLoader", DoNotGenerateAcw=true)>]
type CursorLoader = class
    inherit AsyncTaskLoader

Inheritance: Object

Object

Loader

AsyncTaskLoader
CursorLoader

Attributes: RegisterAttribute

Remarks

A loader that queries the ContentResolver and returns a Cursor. This class implements the Loader protocol in a standard way for querying cursors, building on AsyncTaskLoader to perform the cursor query on a background thread so that it does not block the application's UI.

A CursorLoader must be built with the full information for the query to perform, either through the #CursorLoader(Context, Uri, String[], String, String[], String) or creating an empty instance with #CursorLoader(Context) and filling in the desired parameters with #setUri(Uri), #setSelection(String), #setSelectionArgs(String[]), #setSortOrder(String), and #setProjection(String[]).

This member is deprecated. Use the Support Libraryandroidx.loader.content.CursorLoader

Java documentation for android.content.CursorLoader.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Name	Description
CursorLoader(Context, Uri, String[], String, String[], String)	Creates a fully-specified CursorLoader.
CursorLoader(Context)	Creates an empty unspecified CursorLoader.
CursorLoader(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

Name	Description
Class	Returns the runtime class of this `Object`. (Inherited from Object)
Context	(Inherited from Loader)
Handle	The handle to the underlying Android instance. (Inherited from Object)
Id	(Inherited from Loader)
IsAbandoned	Return whether this loader has been abandoned. (Inherited from Loader)
IsLoadInBackgroundCanceled	Returns true if the current invocation of `#loadInBackground` is being canceled. (Inherited from AsyncTaskLoader)
IsReset	Return whether this load has been reset. (Inherited from Loader)
IsStarted	Return whether this load has been started. (Inherited from Loader)
JniIdentityHashCode	Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object)
JniPeerMembers	Gets the JNI metadata used to invoke members of this Java peer.
PeerReference	Gets the JNI object reference for this Java peer. (Inherited from Object)
Selection
SortOrder
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
Uri

Methods

Name	Description
Abandon()	This function will normally be called for you automatically by `android.app.LoaderManager` when restarting a Loader. (Inherited from Loader)
CancelLoad()	Obsolete. Attempt to cancel the current load task. Must be called on the main thread of the process. Cancellation is not an immediate operation, since the load is performed in a background thread. If there is currently a load in progress, this method requests that the load be canceled, and notes this is the case; once the background thread has completed its work its remaining state will be cleared. If another load request comes in during this time, it will be held until the canceled load is complete. (Inherited from AsyncTaskLoader)
CancelLoadInBackground()	Called on the main thread to abort a load in progress. (Inherited from AsyncTaskLoader)
Clone()	Creates and returns a copy of this object. (Inherited from Object)
CommitContentChanged()	Commit that you have actually fully processed a content change that was returned by `#takeContentChanged`. (Inherited from Loader)
DataToString(Object)	For debugging, converts an instance of the Loader's data class to a string that can be printed. (Inherited from Loader)
DeliverCancellation()	Informs the registered `OnLoadCanceledListener` that the load has been canceled. (Inherited from Loader)
DeliverResult(ICursor)	Sends the result of the load to the registered listener.
DeliverResult(Object)	Sends the result of the load to the registered listener. (Inherited from Loader)
Dispose()	Releases the resources held by this Java peer. (Inherited from Object)
Dispose(Boolean)	Releases the resources held by this Java peer. (Inherited from Object)
Dump(String, FileDescriptor, PrintWriter, String[])	Print the Loader's state into the given stream. (Inherited from Loader)
DumpAsync(String, FileDescriptor, PrintWriter, String[])	Print the Loader's state into the given stream. (Inherited from Loader)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
ForceLoad()	Force an asynchronous load. (Inherited from Loader)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetProjection()
GetSelectionArgs()
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
LoadInBackground()	Called on a worker thread to perform the actual load and to return the result of the load operation.
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
OnAbandon()	Subclasses implement this to take care of being abandoned. (Inherited from Loader)
OnCanceled(ICursor)	Called if the task was canceled before it was completed.
OnCanceled(Object)	Called if the task was canceled before it was completed. (Inherited from AsyncTaskLoader)
OnCancelLoad()	Subclasses must implement this to take care of requests to `#cancelLoad()`. (Inherited from Loader)
OnContentChanged()	Called when `ForceLoadContentObserver` detects a change. (Inherited from Loader)
OnForceLoad()	Subclasses must implement this to take care of requests to `#forceLoad()`. (Inherited from Loader)
OnLoadInBackground()	Calls `#loadInBackground()`. (Inherited from AsyncTaskLoader)
OnReset()	Subclasses must implement this to take care of resetting their loader, as per `#reset()`. (Inherited from Loader)
OnStartLoading()	Subclasses must implement this to take care of loading their data, as per `#startLoading()`. (Inherited from Loader)
OnStopLoading()	Subclasses must implement this to take care of stopping their loader, as per `#stopLoading()`. (Inherited from Loader)
RegisterListener(Int32, Loader+IOnLoadCompleteListener)	Registers a class that will receive callbacks when a load is complete. (Inherited from Loader)
RegisterOnLoadCanceledListener(Loader+IOnLoadCanceledListener)	Registers a listener that will receive callbacks when a load is canceled. (Inherited from Loader)
Reset()	This function will normally be called for you automatically by `android.app.LoaderManager` when destroying a Loader. (Inherited from Loader)
RollbackContentChanged()	Report that you have abandoned the processing of a content change that was returned by `#takeContentChanged()` and would like to rollback to the state where there is again a pending content change. (Inherited from Loader)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetProjection(String[])
SetSelectionArgs(String[])
SetUpdateThrottle(Int64)	Set amount to throttle updates by. (Inherited from AsyncTaskLoader)
StartLoading()	This function will normally be called for you automatically by `android.app.LoaderManager` when the associated fragment/activity is being started. (Inherited from Loader)
StopLoading()	This function will normally be called for you automatically by `android.app.LoaderManager` when the associated fragment/activity is being stopped. (Inherited from Loader)
TakeContentChanged()	Take the current flag indicating whether the loader's content had changed while it was stopped. (Inherited from Loader)
ToArray<T>()	Creates a managed array from this Java array wrapper. (Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	Unregisters this Java peer from the interop runtime. (Inherited from Object)
UnregisterListener(Loader+IOnLoadCompleteListener)	Remove a listener that was previously added with `#registerListener`. (Inherited from Loader)
UnregisterOnLoadCanceledListener(Loader+IOnLoadCanceledListener)	Unregisters a listener that was previously added with `#registerOnLoadCanceledListener`. (Inherited from Loader)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

Name	Description
IJavaPeerable.Disposed()	Notifies the interop runtime that this managed peer has been disposed. (Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	Releases this Java peer unless it is retained by another managed reference. (Inherited from Object)
IJavaPeerable.Finalized()	Notifies the interop runtime that this managed peer has been finalized. (Inherited from Object)
IJavaPeerable.JniManagedPeerState	Gets the state that describes the relationship between this managed peer and its JNI reference. (Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	Sets the interop identity hash code for this Java peer. (Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	Sets the managed and JNI peer state for this Java peer. (Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	Sets the JNI object reference used by this managed peer. (Inherited from Object)

Extension Methods

Name	Description
GetJniTypeName(IJavaPeerable)	Gets the JNI name of the type of the instance `self`.
JavaAs<TResult>(IJavaPeerable)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.
JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
TryJavaCast<TResult>(IJavaPeerable, TResult)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.

Applies to