ContentResolver | API reference | Android Developers (original) (raw)
public abstract class ContentResolverextends [Object](/reference/java/lang/Object) ``
This class provides applications access to the content model.
Developer Guides
For more information about using a ContentResolver with content providers, read theContent Providers developer guide.
Summary
| Nested classes | |
|---|---|
| class | ContentResolver.MimeTypeInfo Detailed description of a specific MIME type, including an icon and label that describe the type. |
| Constants | |
|---|---|
| String | ANY_CURSOR_ITEM_TYPE This is the Android platform's generic MIME type to match any MIME type of the form "CURSOR_ITEM_BASE_TYPE/SUB_TYPE". |
| String | CURSOR_DIR_BASE_TYPE This is the Android platform's base MIME type for a content: URI containing a Cursor of zero or more items. |
| String | CURSOR_ITEM_BASE_TYPE This is the Android platform's base MIME type for a content: URI containing a Cursor of a single item. |
| String | EXTRA_HONORED_ARGS Allows provider to report back to client which query keys are honored in a Cursor. |
| String | EXTRA_REFRESH_SUPPORTED An extra boolean describing whether a particular provider supports refresh or not. |
| String | EXTRA_SIZE An extra Point describing the optimal size for a requested image resource, in pixels. |
| String | EXTRA_TOTAL_COUNT Added to Cursor extras Bundle to indicate total row count of recordset when paging is supported. |
| int | NOTIFY_DELETE Flag for notifyChange(Uri,ContentObserver,int): typically set by a ContentProvider to indicate that this notification is the result of a ContentProvider.delete call. |
| int | NOTIFY_INSERT Flag for notifyChange(Uri,ContentObserver,int): typically set by a ContentProvider to indicate that this notification is the result of an ContentProvider.insert call. |
| int | NOTIFY_SKIP_NOTIFY_FOR_DESCENDANTS Flag for notifyChange(Uri,ContentObserver,int): if set, this notification will be skipped if it is being delivered to the root URI of a ContentObserver that is using "notify for descendants." The purpose of this is to allow the provide to send a general notification of "something under X" changed that observers of that specific URI can receive, while also sending a specific URI under X. |
| int | NOTIFY_SYNC_TO_NETWORK Flag for notifyChange(Uri,ContentObserver,int): attempt to sync the change to the network. |
| int | NOTIFY_UPDATE Flag for notifyChange(Uri,ContentObserver,int): typically set by a ContentProvider to indicate that this notification is the result of an ContentProvider.update call. |
| String | QUERY_ARG_GROUP_COLUMNS Specifies the list of columns (stored as a String[]) against which to group results. |
| String | QUERY_ARG_LIMIT Specifies the max number of rows to include in a Cursor. |
| String | QUERY_ARG_OFFSET Specifies the offset row index within a Cursor. |
| String | QUERY_ARG_SORT_COLLATION Allows client to specify a hint to the provider declaring which collation to use when sorting values. |
| String | QUERY_ARG_SORT_COLUMNS Specifies the list of columns (stored as a String[]) against which to sort results. |
| String | QUERY_ARG_SORT_DIRECTION Specifies desired sort order. |
| String | QUERY_ARG_SORT_LOCALE Allows client to specify a hint to the provider declaring which locale to use when sorting values. |
| String | QUERY_ARG_SQL_GROUP_BY Key for an SQL style GROUP BY string that may be present in the query Bundle argument passed toContentProvider.query(Uri,String[],Bundle,CancellationSignal). |
| String | QUERY_ARG_SQL_HAVING Key for an SQL style HAVING string that may be present in the query Bundle argument passed toContentProvider.query(Uri,String[],Bundle,CancellationSignal). |
| String | QUERY_ARG_SQL_LIMIT Key for an SQL style LIMIT string that may be present in the query Bundle argument passed toContentProvider.query(Uri,String[],Bundle,CancellationSignal). |
| String | QUERY_ARG_SQL_SELECTION Key for an SQL style selection string that may be present in the query Bundle argument passed to ContentProvider.query(Uri,String[],Bundle,CancellationSignal) when called by a legacy client. |
| String | QUERY_ARG_SQL_SELECTION_ARGS Key for SQL selection string arguments list. |
| String | QUERY_ARG_SQL_SORT_ORDER Key for an SQL style sort string that may be present in the query Bundle argument passed to ContentProvider.query(Uri,String[],Bundle,CancellationSignal) when called by a legacy client. |
| int | QUERY_SORT_DIRECTION_ASCENDING |
| int | QUERY_SORT_DIRECTION_DESCENDING |
| String | SCHEME_ANDROID_RESOURCE |
| String | SCHEME_CONTENT |
| String | SCHEME_FILE |
| String | SYNC_EXTRAS_ACCOUNT This constant was deprecated in API level 15. instead userequestSync(android.accounts.Account,String,android.os.Bundle) |
| String | SYNC_EXTRAS_DISCARD_LOCAL_DELETIONS Indicates that the sync adapter should not proceed with the delete operations, if it determines that there are too many. |
| String | SYNC_EXTRAS_DO_NOT_RETRY If this extra is set to true then the request will not be retried if it fails. |
| String | SYNC_EXTRAS_EXPEDITED If this extra is set to true, the sync request will be scheduled at the front of the sync request queue, but it is still subject to JobScheduler quota and throttling due to App Standby buckets. |
| String | SYNC_EXTRAS_FORCE This constant was deprecated in API level 15. instead useSYNC_EXTRAS_MANUAL |
| String | SYNC_EXTRAS_IGNORE_BACKOFF If this extra is set to true then any backoffs for the initial attempt (e.g. due to retries) are ignored by the sync scheduler. |
| String | SYNC_EXTRAS_IGNORE_SETTINGS If this extra is set to true then the sync settings (like getSyncAutomatically()) are ignored by the sync scheduler. |
| String | SYNC_EXTRAS_INITIALIZE Set by the SyncManager to request that the SyncAdapter initialize itself for the given account/authority pair. |
| String | SYNC_EXTRAS_MANUAL Setting this extra is the equivalent of setting both SYNC_EXTRAS_IGNORE_SETTINGS and SYNC_EXTRAS_IGNORE_BACKOFF |
| String | SYNC_EXTRAS_OVERRIDE_TOO_MANY_DELETIONS Indicates that the sync adapter should proceed with the delete operations, even if it determines that there are too many. |
| String | SYNC_EXTRAS_REQUIRE_CHARGING If this extra is set to true, the sync request will be scheduled only when the device is plugged in. |
| String | SYNC_EXTRAS_SCHEDULE_AS_EXPEDITED_JOB Run this sync operation as an "expedited job" (see JobInfo.Builder.setExpedited(boolean)). |
| String | SYNC_EXTRAS_UPLOAD Indicates that this sync is intended to only upload local changes to the server. |
| int | SYNC_OBSERVER_TYPE_ACTIVE |
| int | SYNC_OBSERVER_TYPE_PENDING |
| int | SYNC_OBSERVER_TYPE_SETTINGS |
| Public constructors |
|---|
| ContentResolver(Context context) Note: passing a null context here could lead to unexpected behavior in certain ContentResolver APIs so it is highly recommended to pass a non-null context here. |
| Public methods | |
|---|---|
| finalContentProviderClient | acquireContentProviderClient(Uri uri) Returns a ContentProviderClient that is associated with the ContentProvider that services the content at uri, starting the provider if necessary. |
| finalContentProviderClient | acquireContentProviderClient(String name) Returns a ContentProviderClient that is associated with the ContentProvider with the authority of name, starting the provider if necessary. |
| finalContentProviderClient | acquireUnstableContentProviderClient(String name) Like acquireContentProviderClient(String), but for use when you do not trust the stability of the target content provider. |
| finalContentProviderClient | acquireUnstableContentProviderClient(Uri uri) Like acquireContentProviderClient(Uri), but for use when you do not trust the stability of the target content provider. |
| static void | addPeriodicSync(Account account, String authority, Bundle extras, long pollFrequency) Specifies that a sync should be requested with the specified the account, authority, and extras at the given frequency. |
| staticObject | addStatusChangeListener(int mask, SyncStatusObserver callback) Request notifications when the different aspects of the SyncManager change. |
| ContentProviderResult[] | applyBatch(String authority, ArrayList<ContentProviderOperation> operations) Applies each of the ContentProviderOperation objects and returns an array of their results. |
| final int | bulkInsert(Uri url, ContentValues[] values) Inserts multiple rows into a table at the given URL. |
| finalBundle | call(Uri uri, String method, String arg, Bundle extras) Call a provider-defined method. |
| finalBundle | call(String authority, String method, String arg, Bundle extras) |
| void | cancelSync(Uri uri) This method was deprecated in API level 15. instead use cancelSync(android.accounts.Account,String) |
| static void | cancelSync(SyncRequest request) Remove the specified sync. |
| static void | cancelSync(Account account, String authority) Cancel any active or pending syncs that match account and authority. |
| finalUri | canonicalize(Uri url) Transform the given url to a canonical representation of its referenced resource, which can be used across devices, persisted, backed up and restored, etc. |
| final int | delete(Uri url, String where, String[] selectionArgs) Deletes row(s) specified by a content URI. |
| final int | delete(Uri url, Bundle extras) Deletes row(s) specified by a content URI. |
| staticSyncInfo | getCurrentSync() This method was deprecated in API level 15. Since multiple concurrent syncs are now supported you should usegetCurrentSyncs() to get the accurate list of current syncs. This method returns the first item from the list of current syncs or null if there are none. |
| staticList<SyncInfo> | getCurrentSyncs() Returns a list with information about all the active syncs. |
| static int | getIsSyncable(Account account, String authority) Check if this account/provider is syncable. |
| static boolean | getMasterSyncAutomatically() Gets the global auto-sync setting that applies to all the providers and accounts. |
| List<UriPermission> | getOutgoingPersistedUriPermissions() Return list of all persisted URI permission grants that are hosted by the calling app. |
| staticList<PeriodicSync> | getPeriodicSyncs(Account account, String authority) Get the list of information about the periodic syncs for the given account and authority. |
| List<UriPermission> | getPersistedUriPermissions() Return list of all URI permission grants that have been persisted by the calling app. |
| String[] | getStreamTypes(Uri url, String mimeTypeFilter) Query for the possible MIME types for the representations the given content URL can be returned when opened as as stream withopenTypedAssetFileDescriptor(Uri, String, Bundle). |
| staticSyncAdapterType[] | getSyncAdapterTypes() Get information about the SyncAdapters that are known to the system. |
| static boolean | getSyncAutomatically(Account account, String authority) Check if the provider should be synced when a network tickle is receivedThis method requires the caller to hold the permissionManifest.permission.READ_SYNC_SETTINGS. |
| finalString | getType(Uri url) Return the MIME type of the given content URL. |
| finalContentResolver.MimeTypeInfo | getTypeInfo(String mimeType) Return a detailed description of the given MIME type, including an icon and label that describe the type. |
| finalUri | insert(Uri url, ContentValues values, Bundle extras) Inserts a row into a table at the given URL. |
| finalUri | insert(Uri url, ContentValues values) Inserts a row into a table at the given URL. |
| static boolean | isSyncActive(Account account, String authority) Returns true if there is currently a sync operation for the given account or authority actively being processed. |
| static boolean | isSyncPending(Account account, String authority) Return true if the pending status is true of any matching authorities. |
| Bitmap | loadThumbnail(Uri uri, Size size, CancellationSignal signal) Convenience method that efficiently loads a visual thumbnail for the given Uri. |
| void | notifyChange(Collection<Uri> uris, ContentObserver observer, int flags) Notify registered observers that several rows have been updated. |
| void | notifyChange(Uri uri, ContentObserver observer, boolean syncToNetwork) This method was deprecated in API level 30. callers should consider migrating tonotifyChange(Uri,ContentObserver,int), as it offers support for many more options than justNOTIFY_SYNC_TO_NETWORK. |
| void | notifyChange(Uri uri, ContentObserver observer, int flags) Notify registered observers that a row was updated. |
| void | notifyChange(Uri uri, ContentObserver observer) Notify registered observers that a row was updated and attempt to sync changes to the network. |
| finalAssetFileDescriptor | openAssetFile(Uri uri, String mode, CancellationSignal signal) |
| finalAssetFileDescriptor | openAssetFileDescriptor(Uri uri, String mode, CancellationSignal cancellationSignal) Open a raw file descriptor to access data under a URI. |
| finalAssetFileDescriptor | openAssetFileDescriptor(Uri uri, String mode) Open a raw file descriptor to access data under a URI. |
| finalParcelFileDescriptor | openFile(Uri uri, String mode, CancellationSignal signal) |
| finalParcelFileDescriptor | openFileDescriptor(Uri uri, String mode, CancellationSignal cancellationSignal) Open a raw file descriptor to access data under a URI. |
| finalParcelFileDescriptor | openFileDescriptor(Uri uri, String mode) Open a raw file descriptor to access data under a URI. |
| finalInputStream | openInputStream(Uri uri) Open a stream on to the content associated with a content URI. |
| finalOutputStream | openOutputStream(Uri uri) Synonym for openOutputStream(uri, "w"). |
| finalOutputStream | openOutputStream(Uri uri, String mode) Open a stream on to the content associated with a content URI. |
| finalAssetFileDescriptor | openTypedAssetFile(Uri uri, String mimeTypeFilter, Bundle opts, CancellationSignal signal) |
| finalAssetFileDescriptor | openTypedAssetFileDescriptor(Uri uri, String mimeType, Bundle opts, CancellationSignal cancellationSignal) Open a raw file descriptor to access (potentially type transformed) data from a "content:" URI. |
| finalAssetFileDescriptor | openTypedAssetFileDescriptor(Uri uri, String mimeType, Bundle opts) Open a raw file descriptor to access (potentially type transformed) data from a "content:" URI. |
| finalCursor | query(Uri uri, String[] projection, Bundle queryArgs, CancellationSignal cancellationSignal) Query the given URI, returning a Cursor over the result set with support for cancellation. |
| finalCursor | query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder, CancellationSignal cancellationSignal) Query the given URI, returning a Cursor over the result set with optional support for cancellation. |
| finalCursor | query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) Query the given URI, returning a Cursor over the result set. |
| final boolean | refresh(Uri url, Bundle extras, CancellationSignal cancellationSignal) This allows clients to request an explicit refresh of content identified by uri. |
| final void | registerContentObserver(Uri uri, boolean notifyForDescendants, ContentObserver observer) Register an observer class that gets callbacks when data identified by a given content URI changes. |
| void | releasePersistableUriPermission(Uri uri, int modeFlags) Relinquish a persisted URI permission grant. |
| static void | removePeriodicSync(Account account, String authority, Bundle extras) Remove a periodic sync. |
| static void | removeStatusChangeListener(Object handle) Remove a previously registered status change listener. |
| static void | requestSync(Account account, String authority, Bundle extras) Start an asynchronous sync operation. |
| static void | requestSync(SyncRequest request) Register a sync with the SyncManager. |
| static void | setIsSyncable(Account account, String authority, int syncable) Set whether this account/provider is syncable. |
| static void | setMasterSyncAutomatically(boolean sync) Sets the global auto-sync setting that applies to all the providers and accounts. |
| static void | setSyncAutomatically(Account account, String authority, boolean sync) Set whether or not the provider is synced when it receives a network tickle. |
| void | startSync(Uri uri, Bundle extras) This method was deprecated in API level 15. instead userequestSync(android.accounts.Account,String,android.os.Bundle) |
| void | takePersistableUriPermission(Uri uri, int modeFlags) Take a persistable URI permission grant that has been offered. |
| finalUri | uncanonicalize(Uri url) Given a canonical Uri previously generated by canonicalize(Uri), convert it to its local non-canonical form. |
| final void | unregisterContentObserver(ContentObserver observer) Unregisters a change observer. |
| final int | update(Uri uri, ContentValues values, Bundle extras) Update row(s) in a content URI. |
| final int | update(Uri uri, ContentValues values, String where, String[] selectionArgs) Update row(s) in a content URI. |
| static void | validateSyncExtrasBundle(Bundle extras) Check that only values of the following types are in the Bundle: Integer Long Boolean Float Double String Account null |
| staticContentResolver | wrap(ContentProviderClient wrapped) Create a ContentResolver instance that redirects all its methods to the given ContentProviderClient. |
| staticContentResolver | wrap(ContentProvider wrapped) Create a ContentResolver instance that redirects all its methods to the given ContentProvider. |
| Inherited methods |
|---|
| From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. finalClass<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted. |
Constants
ANY_CURSOR_ITEM_TYPE
public static final String ANY_CURSOR_ITEM_TYPE
This is the Android platform's generic MIME type to match any MIME type of the form "[CURSOR_ITEM_BASE_TYPE](/reference/android/content/ContentResolver#CURSOR%5FITEM%5FBASE%5FTYPE)/SUB_TYPE".SUB_TYPE is the sub-type of the application-dependent content, e.g., "audio", "video", "playlist".
Constant Value: "vnd.android.cursor.item/*"
CURSOR_DIR_BASE_TYPE
public static final String CURSOR_DIR_BASE_TYPE
This is the Android platform's base MIME type for a content: URI containing a Cursor of zero or more items. Applications should use this as the base type along with their own sub-type of their content: URIs that represent a directory of items. For example, hypothetical IMAP email client may have a URIcontent://com.company.provider.imap/inbox for all of the messages in its inbox, whose MIME type would be reported asCURSOR_DIR_BASE_TYPE + "/vnd.company.imap-msg"
Note how the base MIME type varies between this and[CURSOR_ITEM_BASE_TYPE](/reference/android/content/ContentResolver#CURSOR%5FITEM%5FBASE%5FTYPE) depending on whether there is one single item or multiple items in the data set, while the sub-type remains the same because in either case the data structure contained in the cursor is the same.
Constant Value: "vnd.android.cursor.dir"
CURSOR_ITEM_BASE_TYPE
public static final String CURSOR_ITEM_BASE_TYPE
This is the Android platform's base MIME type for a content: URI containing a Cursor of a single item. Applications should use this as the base type along with their own sub-type of their content: URIs that represent a particular item. For example, hypothetical IMAP email client may have a URIcontent://com.company.provider.imap/inbox/1 for a particular message in the inbox, whose MIME type would be reported asCURSOR_ITEM_BASE_TYPE + "/vnd.company.imap-msg"
Compare with [CURSOR_DIR_BASE_TYPE](/reference/android/content/ContentResolver#CURSOR%5FDIR%5FBASE%5FTYPE).
Constant Value: "vnd.android.cursor.item"
public static final String EXTRA_REFRESH_SUPPORTED
An extra boolean describing whether a particular provider supports refresh or not. If a provider supports refresh, it should include this key in its returned Cursor as part of its query call.
Constant Value: "android.content.extra.REFRESH_SUPPORTED"
public static final String EXTRA_TOTAL_COUNT
Added to [Cursor](/reference/android/database/Cursor) extras [Bundle](/reference/android/os/Bundle) to indicate total row count of recordset when paging is supported. Providers must include this when implementing paging support.
A provider may return -1 that row count of the recordset is unknown.
Providers having returned -1 in a previous query are recommended to send content change notification once (if) full recordset size becomes known.
Constant Value: "android.content.extra.TOTAL_COUNT"
NOTIFY_SKIP_NOTIFY_FOR_DESCENDANTS
public static final int NOTIFY_SKIP_NOTIFY_FOR_DESCENDANTS
Flag for [notifyChange(Uri,ContentObserver,int)](/reference/android/content/ContentResolver#notifyChange%28android.net.Uri,%20android.database.ContentObserver,%20int%29): if set, this notification will be skipped if it is being delivered to the root URI of a ContentObserver that is using "notify for descendants." The purpose of this is to allow the provide to send a general notification of "something under X" changed that observers of that specific URI can receive, while also sending a specific URI under X. It would use this flag when sending the former, so that observers of "X and descendants" only see the latter.
Constant Value: 2 (0x00000002)
NOTIFY_SYNC_TO_NETWORK
public static final int NOTIFY_SYNC_TO_NETWORK
Flag for [notifyChange(Uri,ContentObserver,int)](/reference/android/content/ContentResolver#notifyChange%28android.net.Uri,%20android.database.ContentObserver,%20int%29): attempt to sync the change to the network.
Constant Value: 1 (0x00000001)
QUERY_ARG_GROUP_COLUMNS
public static final String QUERY_ARG_GROUP_COLUMNS
Specifies the list of columns (stored as a String[]) against which to group results. When column values are identical, multiple records are collapsed together into a single record.
Columns present in this list must also be included in the projection supplied to[ContentResolver.query(Uri,String[],Bundle,CancellationSignal)](/reference/android/content/ContentResolver#query%28android.net.Uri,%20java.lang.String[],%20android.os.Bundle,%20android.os.CancellationSignal%29).
Apps targeting [Build.VERSION_CODES.R](/reference/android/os/Build.VERSION%5FCODES#R) or higher:
[ContentProvider](/reference/android/content/ContentProvider)implementations: When preparing data in[ContentProvider.query(Uri,String[],Bundle,CancellationSignal)](/reference/android/content/ContentProvider#query%28android.net.Uri,%20java.lang.String[],%20android.os.Bundle,%20android.os.CancellationSignal%29), if group columns is reflected in the returned Cursor, it is strongly recommended that[QUERY_ARG_SORT_COLUMNS](/reference/android/content/ContentResolver#QUERY%5FARG%5FSORT%5FCOLUMNS)then be included in the array of honored arguments reflected in[Cursor](/reference/android/database/Cursor)extras[Bundle](/reference/android/os/Bundle)under[EXTRA_HONORED_ARGS](/reference/android/content/ContentResolver#EXTRA%5FHONORED%5FARGS).- When querying a provider, where no QUERY_ARG_SQL* otherwise exists in the arguments
[Bundle](/reference/android/os/Bundle), the Content framework will attempt to synthesize an QUERY_ARG_SQL* argument using the corresponding QUERY_ARG_SORT* values.
Constant Value: "android:query-arg-group-columns"
QUERY_ARG_LIMIT
public static final String QUERY_ARG_LIMIT
Specifies the max number of rows to include in a Cursor.
Constant Value: "android:query-arg-limit"
QUERY_ARG_OFFSET
public static final String QUERY_ARG_OFFSET
Specifies the offset row index within a Cursor.
Constant Value: "android:query-arg-offset"
QUERY_ARG_SORT_COLLATION
public static final String QUERY_ARG_SORT_COLLATION
Allows client to specify a hint to the provider declaring which collation to use when sorting values.
Providers may support custom collators. When specifying a custom collator the value is determined by the Provider.
[ContentProvider](/reference/android/content/ContentProvider) implementations: When preparing data in[ContentProvider.query(Uri,String[],Bundle,CancellationSignal)](/reference/android/content/ContentProvider#query%28android.net.Uri,%20java.lang.String[],%20android.os.Bundle,%20android.os.CancellationSignal%29), if sort collation is reflected in the returned Cursor, it is strongly recommended that [QUERY_ARG_SORT_COLLATION](/reference/android/content/ContentResolver#QUERY%5FARG%5FSORT%5FCOLLATION) then be included in the array of honored arguments reflected in [Cursor](/reference/android/database/Cursor) extras[Bundle](/reference/android/os/Bundle) under [EXTRA_HONORED_ARGS](/reference/android/content/ContentResolver#EXTRA%5FHONORED%5FARGS).
When querying a provider, where no QUERY_ARG_SQL* otherwise exists in the arguments [Bundle](/reference/android/os/Bundle), the Content framework will attempt to synthesize a QUERY_ARG_SQL* argument using the corresponding QUERY_ARG_SORT* values.
Constant Value: "android:query-arg-sort-collation"
QUERY_ARG_SORT_COLUMNS
public static final String QUERY_ARG_SORT_COLUMNS
Specifies the list of columns (stored as a String[]) against which to sort results. When first column values are identical, records are then sorted based on second column values, and so on.
Columns present in this list must also be included in the projection supplied to[ContentResolver.query(Uri,String[],Bundle,CancellationSignal)](/reference/android/content/ContentResolver#query%28android.net.Uri,%20java.lang.String[],%20android.os.Bundle,%20android.os.CancellationSignal%29).
Apps targeting [Build.VERSION_CODES.O](/reference/android/os/Build.VERSION%5FCODES#O) or higher:
[ContentProvider](/reference/android/content/ContentProvider)implementations: When preparing data in[ContentProvider.query(Uri,String[],Bundle,CancellationSignal)](/reference/android/content/ContentProvider#query%28android.net.Uri,%20java.lang.String[],%20android.os.Bundle,%20android.os.CancellationSignal%29), if sort columns is reflected in the returned Cursor, it is strongly recommended that[QUERY_ARG_SORT_COLUMNS](/reference/android/content/ContentResolver#QUERY%5FARG%5FSORT%5FCOLUMNS)then be included in the array of honored arguments reflected in[Cursor](/reference/android/database/Cursor)extras[Bundle](/reference/android/os/Bundle)under[EXTRA_HONORED_ARGS](/reference/android/content/ContentResolver#EXTRA%5FHONORED%5FARGS).- When querying a provider, where no QUERY_ARG_SQL* otherwise exists in the arguments
[Bundle](/reference/android/os/Bundle), the Content framework will attempt to synthesize a QUERY_ARG_SQL* argument using the corresponding QUERY_ARG_SORT* values.
Constant Value: "android:query-arg-sort-columns"
QUERY_ARG_SORT_DIRECTION
public static final String QUERY_ARG_SORT_DIRECTION
Specifies desired sort order. When unspecified a provider may provide a default sort direction, or choose to return unsorted results.
Apps targeting [Build.VERSION_CODES.O](/reference/android/os/Build.VERSION%5FCODES#O) or higher:
[ContentProvider](/reference/android/content/ContentProvider)implementations: When preparing data in[ContentProvider.query(Uri,String[],Bundle,CancellationSignal)](/reference/android/content/ContentProvider#query%28android.net.Uri,%20java.lang.String[],%20android.os.Bundle,%20android.os.CancellationSignal%29), if sort direction is reflected in the returned Cursor, it is strongly recommended that[QUERY_ARG_SORT_DIRECTION](/reference/android/content/ContentResolver#QUERY%5FARG%5FSORT%5FDIRECTION)then be included in the array of honored arguments reflected in[Cursor](/reference/android/database/Cursor)extras[Bundle](/reference/android/os/Bundle)under[EXTRA_HONORED_ARGS](/reference/android/content/ContentResolver#EXTRA%5FHONORED%5FARGS).- When querying a provider, where no QUERY_ARG_SQL* otherwise exists in the arguments
[Bundle](/reference/android/os/Bundle), the Content framework will attempt to synthesize a QUERY_ARG_SQL* argument using the corresponding QUERY_ARG_SORT* values.
Constant Value: "android:query-arg-sort-direction"
QUERY_ARG_SORT_LOCALE
public static final String QUERY_ARG_SORT_LOCALE
Allows client to specify a hint to the provider declaring which locale to use when sorting values.
The value is defined as a RFC 3066 locale ID followed by an optional keyword list, which is the locale format used to configure ICU through classes like [ULocale](/reference/android/icu/util/ULocale). This supports requesting advanced sorting options, such as de@collation=phonebook,zh@collation=pinyin, etc.
[ContentProvider](/reference/android/content/ContentProvider) implementations: When preparing data in[ContentProvider.query(Uri,String[],Bundle,CancellationSignal)](/reference/android/content/ContentProvider#query%28android.net.Uri,%20java.lang.String[],%20android.os.Bundle,%20android.os.CancellationSignal%29), if sort locale is reflected in the returned Cursor, it is strongly recommended that [QUERY_ARG_SORT_LOCALE](/reference/android/content/ContentResolver#QUERY%5FARG%5FSORT%5FLOCALE) then be included in the array of honored arguments reflected in [Cursor](/reference/android/database/Cursor) extras[Bundle](/reference/android/os/Bundle) under [EXTRA_HONORED_ARGS](/reference/android/content/ContentResolver#EXTRA%5FHONORED%5FARGS).
Constant Value: "android:query-arg-sort-locale"
QUERY_ARG_SQL_SELECTION_ARGS
public static final String QUERY_ARG_SQL_SELECTION_ARGS
Key for SQL selection string arguments list.
Clients should never include user supplied values directly in the selection string, as this presents an avenue for SQL injection attacks. In lieu of this, a client should use standard placeholder notation to represent values in a selection string, then supply a corresponding value in [.QUERY_ARG_SQL_SELECTION_ARGS](/reference/android/content/ContentResolver#QUERY%5FARG%5FSQL%5FSELECTION%5FARGS).
Apps targeting [Build.VERSION_CODES.O](/reference/android/os/Build.VERSION%5FCODES#O) or higher are strongly encourage to use structured query arguments in lieu of opaque SQL query clauses.
See also:
[QUERY_ARG_SORT_COLUMNS](/reference/android/content/ContentResolver#QUERY%5FARG%5FSORT%5FCOLUMNS)[QUERY_ARG_SORT_DIRECTION](/reference/android/content/ContentResolver#QUERY%5FARG%5FSORT%5FDIRECTION)[QUERY_ARG_SORT_COLLATION](/reference/android/content/ContentResolver#QUERY%5FARG%5FSORT%5FCOLLATION)[QUERY_ARG_SORT_LOCALE](/reference/android/content/ContentResolver#QUERY%5FARG%5FSORT%5FLOCALE)
Constant Value: "android:query-arg-sql-selection-args"
QUERY_SORT_DIRECTION_ASCENDING
public static final int QUERY_SORT_DIRECTION_ASCENDING
Constant Value: 0 (0x00000000)
QUERY_SORT_DIRECTION_DESCENDING
public static final int QUERY_SORT_DIRECTION_DESCENDING
Constant Value: 1 (0x00000001)
SCHEME_ANDROID_RESOURCE
public static final String SCHEME_ANDROID_RESOURCE
Constant Value: "android.resource"
SCHEME_CONTENT
public static final String SCHEME_CONTENT
Constant Value: "content"
SCHEME_FILE
public static final String SCHEME_FILE
Constant Value: "file"
public static final String SYNC_EXTRAS_DISCARD_LOCAL_DELETIONS
Indicates that the sync adapter should not proceed with the delete operations, if it determines that there are too many. See [SyncResult.tooManyDeletions](/reference/android/content/SyncResult#tooManyDeletions)
Constant Value: "discard_deletions"
public static final String SYNC_EXTRAS_DO_NOT_RETRY
If this extra is set to true then the request will not be retried if it fails.
Constant Value: "do_not_retry"
public static final String SYNC_EXTRAS_EXPEDITED
If this extra is set to true, the sync request will be scheduled at the front of the sync request queue, but it is still subject to JobScheduler quota and throttling due to App Standby buckets.
This is different from [SYNC_EXTRAS_SCHEDULE_AS_EXPEDITED_JOB](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FSCHEDULE%5FAS%5FEXPEDITED%5FJOB).
Constant Value: "expedited"
public static final String SYNC_EXTRAS_FORCE
This constant was deprecated in API level 15.
instead use[SYNC_EXTRAS_MANUAL](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FMANUAL)
Constant Value: "force"
public static final String SYNC_EXTRAS_IGNORE_BACKOFF
If this extra is set to true then any backoffs for the initial attempt (e.g. due to retries) are ignored by the sync scheduler. If this request fails and gets rescheduled then the retries will still honor the backoff.
Constant Value: "ignore_backoff"
public static final String SYNC_EXTRAS_IGNORE_SETTINGS
If this extra is set to true then the sync settings (like getSyncAutomatically()) are ignored by the sync scheduler.
Constant Value: "ignore_settings"
public static final String SYNC_EXTRAS_INITIALIZE
Set by the SyncManager to request that the SyncAdapter initialize itself for the given account/authority pair. One required initialization step is to ensure that [setIsSyncable(android.accounts.Account,String,int)](/reference/android/content/ContentResolver#setIsSyncable%28android.accounts.Account,%20java.lang.String,%20int%29) has been called with a >= 0 value. When this flag is set the SyncAdapter does not need to do a full sync, though it is allowed to do so.
Constant Value: "initialize"
public static final String SYNC_EXTRAS_OVERRIDE_TOO_MANY_DELETIONS
Indicates that the sync adapter should proceed with the delete operations, even if it determines that there are too many. See [SyncResult.tooManyDeletions](/reference/android/content/SyncResult#tooManyDeletions)
Constant Value: "deletions_override"
public static final String SYNC_EXTRAS_REQUIRE_CHARGING
If this extra is set to true, the sync request will be scheduled only when the device is plugged in. This is equivalent to calling setRequiresCharging(true) on [SyncRequest](/reference/android/content/SyncRequest).
Constant Value: "require_charging"
public static final String SYNC_EXTRAS_SCHEDULE_AS_EXPEDITED_JOB
Run this sync operation as an "expedited job" (see [JobInfo.Builder.setExpedited(boolean)](/reference/android/app/job/JobInfo.Builder#setExpedited%28boolean%29)). Normally (if this flag isn't specified), sync operations are executed as regular[JobService](/reference/android/app/job/JobService) jobs.
Because Expedited Jobs have various restrictions compared to regular jobs, this flag cannot be combined with certain other flags, otherwise anIllegalArgumentException will be thrown. Notably, because Expedited Jobs do not support various constraints, the following restriction apply:
- Can't be used with
[SYNC_EXTRAS_REQUIRE_CHARGING](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FREQUIRE%5FCHARGING) - Can't be used with
[SYNC_EXTRAS_EXPEDITED](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FEXPEDITED) - Can't be used on periodic syncs.
- When an expedited-job-sync fails and a retry is scheduled, the retried sync will be scheduled as a regular job unless
[SYNC_EXTRAS_IGNORE_BACKOFF](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FIGNORE%5FBACKOFF)is set.
This is different from [SYNC_EXTRAS_EXPEDITED](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FEXPEDITED).
Constant Value: "schedule_as_expedited_job"
SYNC_OBSERVER_TYPE_ACTIVE
public static final int SYNC_OBSERVER_TYPE_ACTIVE
Constant Value: 4 (0x00000004)
SYNC_OBSERVER_TYPE_PENDING
public static final int SYNC_OBSERVER_TYPE_PENDING
Constant Value: 2 (0x00000002)
SYNC_OBSERVER_TYPE_SETTINGS
public static final int SYNC_OBSERVER_TYPE_SETTINGS
Constant Value: 1 (0x00000001)
Public constructors
ContentResolver
public ContentResolver (Context context)
Note: passing a null context here could lead to unexpected behavior in certain ContentResolver APIs so it is highly recommended to pass a non-null context here.
| Parameters | |
|---|---|
| context | Context: This value may be null. |
Public methods
acquireContentProviderClient
public final ContentProviderClient acquireContentProviderClient (Uri uri)
Returns a [ContentProviderClient](/reference/android/content/ContentProviderClient) that is associated with the [ContentProvider](/reference/android/content/ContentProvider) that services the content at uri, starting the provider if necessary. Returns null if there is no provider associated wih the uri. The caller must indicate that they are done with the provider by calling [ContentProviderClient.release](/reference/android/content/ContentProviderClient#release%28%29) which will allow the system to release the provider if it determines that there is no other reason for keeping it active.
| Parameters | |
|---|---|
| uri | Uri: specifies which provider should be acquired. This value cannot be null. |
| Returns | |
|---|---|
| ContentProviderClient | a ContentProviderClient that is associated with the ContentProvider that services the content at uri or null if there isn't one. |
acquireContentProviderClient
public final ContentProviderClient acquireContentProviderClient (String name)
Returns a [ContentProviderClient](/reference/android/content/ContentProviderClient) that is associated with the [ContentProvider](/reference/android/content/ContentProvider) with the authority of name, starting the provider if necessary. Returns null if there is no provider associated wih the uri. The caller must indicate that they are done with the provider by calling [ContentProviderClient.release](/reference/android/content/ContentProviderClient#release%28%29) which will allow the system to release the provider if it determines that there is no other reason for keeping it active.
| Parameters | |
|---|---|
| name | String: specifies which provider should be acquired. This value cannot be null. |
| Returns | |
|---|---|
| ContentProviderClient | a ContentProviderClient that is associated with the ContentProvider with the authority of name or null if there isn't one. |
acquireUnstableContentProviderClient
public final ContentProviderClient acquireUnstableContentProviderClient (String name)
Like [acquireContentProviderClient(String)](/reference/android/content/ContentResolver#acquireContentProviderClient%28java.lang.String%29), but for use when you do not trust the stability of the target content provider. This turns off the mechanism in the platform clean up processes that are dependent on a content provider if that content provider's process goes away. Normally you can safely assume that once you have acquired a provider, you can freely use it as needed and it won't disappear, even if your process is in the background. If using this method, you need to take care to deal with any failures when communicating with the provider, and be sure to close it so that it can be re-opened later. In particular, catching a[DeadObjectException](/reference/android/os/DeadObjectException) from the calls there will let you know that the content provider has gone away; at that point the current ContentProviderClient object is invalid, and you should release it. You can acquire a new one if you would like to try to restart the provider and perform new operations on it.
| Parameters | |
|---|---|
| name | String: This value cannot be null. |
| Returns | |
|---|---|
| ContentProviderClient | This value may be null. |
acquireUnstableContentProviderClient
public final ContentProviderClient acquireUnstableContentProviderClient (Uri uri)
Like [acquireContentProviderClient(Uri)](/reference/android/content/ContentResolver#acquireContentProviderClient%28android.net.Uri%29), but for use when you do not trust the stability of the target content provider. This turns off the mechanism in the platform clean up processes that are dependent on a content provider if that content provider's process goes away. Normally you can safely assume that once you have acquired a provider, you can freely use it as needed and it won't disappear, even if your process is in the background. If using this method, you need to take care to deal with any failures when communicating with the provider, and be sure to close it so that it can be re-opened later. In particular, catching a[DeadObjectException](/reference/android/os/DeadObjectException) from the calls there will let you know that the content provider has gone away; at that point the current ContentProviderClient object is invalid, and you should release it. You can acquire a new one if you would like to try to restart the provider and perform new operations on it.
| Parameters | |
|---|---|
| uri | Uri: This value cannot be null. |
| Returns | |
|---|---|
| ContentProviderClient | This value may be null. |
addPeriodicSync
public static void addPeriodicSync (Account account, String authority, Bundle extras, long pollFrequency)
Specifies that a sync should be requested with the specified the account, authority, and extras at the given frequency. If there is already another periodic sync scheduled with the account, authority and extras then a new periodic sync won't be added, instead the frequency of the previous one will be updated.
These periodic syncs honor the "syncAutomatically" and "masterSyncAutomatically" settings. Although these sync are scheduled at the specified frequency, it may take longer for it to actually be started if other syncs are ahead of it in the sync operation queue. This means that the actual start time may drift.
Periodic syncs are not allowed to have any of [SYNC_EXTRAS_DO_NOT_RETRY](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FDO%5FNOT%5FRETRY),[SYNC_EXTRAS_IGNORE_BACKOFF](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FIGNORE%5FBACKOFF), [SYNC_EXTRAS_IGNORE_SETTINGS](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FIGNORE%5FSETTINGS),[SYNC_EXTRAS_INITIALIZE](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FINITIALIZE), [SYNC_EXTRAS_FORCE](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FFORCE),[SYNC_EXTRAS_EXPEDITED](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FEXPEDITED), [SYNC_EXTRAS_MANUAL](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FMANUAL),[SYNC_EXTRAS_SCHEDULE_AS_EXPEDITED_JOB](/reference/android/content/ContentResolver#SYNC%5FEXTRAS%5FSCHEDULE%5FAS%5FEXPEDITED%5FJOB) set to true. If any are supplied then an [IllegalArgumentException](/reference/java/lang/IllegalArgumentException) will be thrown.
This method requires the caller to hold the permission[Manifest.permission.WRITE_SYNC_SETTINGS](/reference/android/Manifest.permission#WRITE%5FSYNC%5FSETTINGS).
The bundle for a periodic sync can be queried by applications with the correct permissions using[ContentResolver.getPeriodicSyncs(Account,String)](/reference/android/content/ContentResolver#getPeriodicSyncs%28android.accounts.Account,%20java.lang.String%29), so no sensitive data should be transferred here.
| Parameters | |
|---|---|
| account | Account: the account to specify in the sync |
| authority | String: the provider to specify in the sync request |
| extras | Bundle: extra parameters to go along with the sync request |
| pollFrequency | long: how frequently the sync should be performed, in seconds. On Android API level 24 and above, a minimum interval of 15 minutes is enforced. On previous versions, the minimum interval is 1 hour. |
| Throws | |
|---|---|
| IllegalArgumentException | if an illegal extra was set or if any of the parameters are null. |
addStatusChangeListener
public static Object addStatusChangeListener (int mask, SyncStatusObserver callback)
Request notifications when the different aspects of the SyncManager change. The different items that can be requested are:
[SYNC_OBSERVER_TYPE_PENDING](/reference/android/content/ContentResolver#SYNC%5FOBSERVER%5FTYPE%5FPENDING)[SYNC_OBSERVER_TYPE_ACTIVE](/reference/android/content/ContentResolver#SYNC%5FOBSERVER%5FTYPE%5FACTIVE)[SYNC_OBSERVER_TYPE_SETTINGS](/reference/android/content/ContentResolver#SYNC%5FOBSERVER%5FTYPE%5FSETTINGS)
The caller can set one or more of the status types in the mask for any given listener registration.
| Parameters | |
|---|---|
| mask | int: the status change types that will cause the callback to be invoked |
| callback | SyncStatusObserver: observer to be invoked when the status changes |
| Returns | |
|---|---|
| Object | a handle that can be used to remove the listener at a later time |
bulkInsert
public final int bulkInsert (Uri url, ContentValues[] values)
Inserts multiple rows into a table at the given URL. This function make no guarantees about the atomicity of the insertions.
| Parameters | |
|---|---|
| url | Uri: The URL of the table to insert into. This value cannot be null. |
| values | ContentValues: The initial values for the newly inserted rows. The key is the column name for the field. Passing null will create an empty row. |
| Returns | |
|---|---|
| int | the number of newly created rows. |
call
public final Bundle call (Uri uri, String method, String arg, Bundle extras)
Call a provider-defined method. This can be used to implement read or write interfaces which are cheaper than using a Cursor and/or do not fit into the traditional table model.
| Parameters | |
|---|---|
| uri | Uri: This value cannot be null. |
| method | String: provider-defined method name to call. Opaque to framework, but must be non-null. |
| arg | String: provider-defined String argument. May be null. |
| extras | Bundle: provider-defined Bundle argument. May be null. |
| Returns | |
|---|---|
| Bundle | a result Bundle, possibly null. Will be null if the ContentProvider does not implement call. |
| Throws | |
|---|---|
| IllegalArgumentException | if uri is not known |
| NullPointerException | if uri or method is null |
call
public final Bundle call (String authority, String method, String arg, Bundle extras)
| Parameters | |
|---|---|
| authority | String: This value cannot be null. |
| method | String: This value cannot be null. |
| arg | String: This value may be null. |
| extras | Bundle: This value may be null. |
| Returns | |
|---|---|
| Bundle | This value may be null. |
cancelSync
public void cancelSync (Uri uri)
This method was deprecated in API level 15.
instead use [cancelSync(android.accounts.Account,String)](/reference/android/content/ContentResolver#cancelSync%28android.accounts.Account,%20java.lang.String%29)
Cancel any active or pending syncs that match the Uri. If the uri is null then all syncs will be canceled.
| Parameters | |
|---|---|
| uri | Uri: the uri of the provider to sync or null to sync all providers. |
cancelSync
public static void cancelSync (SyncRequest request)
Remove the specified sync. This will cancel any pending or active syncs. If the request is for a periodic sync, this call will remove any future occurrences.
If a periodic sync is specified, the caller must hold the permission[Manifest.permission.WRITE_SYNC_SETTINGS](/reference/android/Manifest.permission#WRITE%5FSYNC%5FSETTINGS).
It is possible to cancel a sync using a SyncRequest object that is not the same object with which you requested the sync. Do so by building a SyncRequest with the same adapter, frequency, and extras bundle.
| Parameters | |
|---|---|
| request | SyncRequest: SyncRequest object containing information about sync to cancel. |
cancelSync
public static void cancelSync (Account account, String authority)
Cancel any active or pending syncs that match account and authority. The account and authority can each independently be set to null, which means that syncs with any account or authority, respectively, will match.
| Parameters | |
|---|---|
| account | Account: filters the syncs that match by this account |
| authority | String: filters the syncs that match by this authority |
canonicalize
public final Uri canonicalize (Uri url)
Transform the given url to a canonical representation of its referenced resource, which can be used across devices, persisted, backed up and restored, etc. The returned Uri is still a fully capable Uri for use with its content provider, allowing you to do all of the same content provider operations as with the original Uri --[query(Uri, String, Bundle, CancellationSignal)](/reference/android/content/ContentResolver#query%28android.net.Uri,%20java.lang.String[],%20android.os.Bundle,%20android.os.CancellationSignal%29), [openInputStream(android.net.Uri)](/reference/android/content/ContentResolver#openInputStream%28android.net.Uri%29), etc. The only difference in behavior between the original and new Uris is that the content provider may need to do some additional work at each call using it to resolve it to the correct resource, especially if the canonical Uri has been moved to a different environment.
If you are moving a canonical Uri between environments, you should perform another call to [canonicalize(Uri)](/reference/android/content/ContentResolver#canonicalize%28android.net.Uri%29) with that original Uri to re-canonicalize it for the current environment. Alternatively, you may want to use [uncanonicalize(Uri)](/reference/android/content/ContentResolver#uncanonicalize%28android.net.Uri%29) to transform it to a non-canonical Uri that works only in the current environment but potentially more efficiently than the canonical representation.
| Parameters | |
|---|---|
| url | Uri: The Uri that is to be transformed to a canonical representation. Like all resolver calls, the input can be either a non-canonical or canonical Uri. This value cannot be null. |
| Returns | |
|---|---|
| Uri | Returns the official canonical representation of url, or null if the content provider does not support a canonical representation of the given Uri. Many providers may not support canonicalization of some or all of their Uris. |
delete
public final int delete (Uri url, String where, String[] selectionArgs)
Deletes row(s) specified by a content URI. If the content provider supports transactions, the deletion will be atomic.
| Parameters | |
|---|---|
| url | Uri: The URL of the row to delete. This value cannot be null. |
| where | String: A filter to apply to rows before deleting, formatted as an SQL WHERE clause (excluding the WHERE itself). This value may be null. |
| selectionArgs | String: This value may be null. |
| Returns | |
|---|---|
| int | The number of rows deleted. |
delete
public final int delete (Uri url, Bundle extras)
Deletes row(s) specified by a content URI. If the content provider supports transactions, the deletion will be atomic.
| Parameters | |
|---|---|
| url | Uri: The URL of the row to delete. This value cannot be null. |
| extras | Bundle: A Bundle containing additional information necessary for the operation. Arguments may include SQL style arguments, such as ContentResolver.QUERY_ARG_SQL_LIMIT, but note that the documentation for each individual provider will indicate which arguments they support. This value may be null. |
| Returns | |
|---|---|
| int | The number of rows deleted. |
| Throws | |
|---|---|
| IllegalArgumentException | if the provider doesn't support one of the requested Bundle arguments. |
getCurrentSync
public static SyncInfo getCurrentSync ()
This method was deprecated in API level 15.
Since multiple concurrent syncs are now supported you should use[getCurrentSyncs()](/reference/android/content/ContentResolver#getCurrentSyncs%28%29) to get the accurate list of current syncs. This method returns the first item from the list of current syncs or null if there are none.
If a sync is active returns the information about it, otherwise returns null.
This method requires the caller to hold the permission[Manifest.permission.READ_SYNC_STATS](/reference/android/Manifest.permission#READ%5FSYNC%5FSTATS).
| Returns | |
|---|---|
| SyncInfo | the SyncInfo for the currently active sync or null if one is not active. |
getCurrentSyncs
public static List<SyncInfo> getCurrentSyncs ()
Returns a list with information about all the active syncs. This list will be empty if there are no active syncs.
This method requires the caller to hold the permission[Manifest.permission.READ_SYNC_STATS](/reference/android/Manifest.permission#READ%5FSYNC%5FSTATS).
| Returns | |
|---|---|
| List<SyncInfo> | a List of SyncInfo objects for the currently active syncs. |
getIsSyncable
public static int getIsSyncable (Account account, String authority)
Check if this account/provider is syncable.
This method requires the caller to hold the permission[Manifest.permission.READ_SYNC_SETTINGS](/reference/android/Manifest.permission#READ%5FSYNC%5FSETTINGS).
| Parameters | |
|---|---|
| account | Account |
| authority | String |
| Returns | |
|---|---|
| int | >0 if it is syncable, 0 if not, and <0 if the state isn't known yet. |
getMasterSyncAutomatically
public static boolean getMasterSyncAutomatically ()
Gets the global auto-sync setting that applies to all the providers and accounts. If this is false then the per-provider auto-sync setting is ignored.
This method requires the caller to hold the permission[Manifest.permission.READ_SYNC_SETTINGS](/reference/android/Manifest.permission#READ%5FSYNC%5FSETTINGS).
| Returns | |
|---|---|
| boolean | the global auto-sync setting that applies to all the providers and accounts |
getOutgoingPersistedUriPermissions
public List<UriPermission> getOutgoingPersistedUriPermissions ()
Return list of all persisted URI permission grants that are hosted by the calling app. That is, the returned permissions have been granted_from_ the calling app. Only grants taken with[takePersistableUriPermission(Uri,int)](/reference/android/content/ContentResolver#takePersistableUriPermission%28android.net.Uri,%20int%29) are returned.
Note: Some of the returned URIs may not be usable until after the user is unlocked.
| Returns | |
|---|---|
| List<UriPermission> | This value cannot be null. |
getPeriodicSyncs
public static List<PeriodicSync> getPeriodicSyncs (Account account, String authority)
Get the list of information about the periodic syncs for the given account and authority.
This method requires the caller to hold the permission[Manifest.permission.READ_SYNC_SETTINGS](/reference/android/Manifest.permission#READ%5FSYNC%5FSETTINGS).
| Parameters | |
|---|---|
| account | Account: the account whose periodic syncs we are querying |
| authority | String: the provider whose periodic syncs we are querying |
| Returns | |
|---|---|
| List<PeriodicSync> | a list of PeriodicSync objects. This list may be empty but will never be null. |
getPersistedUriPermissions
public List<UriPermission> getPersistedUriPermissions ()
Return list of all URI permission grants that have been persisted by the calling app. That is, the returned permissions have been granted_to_ the calling app. Only persistable grants taken with[takePersistableUriPermission(Uri,int)](/reference/android/content/ContentResolver#takePersistableUriPermission%28android.net.Uri,%20int%29) are returned.
Note: Some of the returned URIs may not be usable until after the user is unlocked.
| Returns | |
|---|---|
| List<UriPermission> | This value cannot be null. |
getStreamTypes
public String[] getStreamTypes (Uri url, String mimeTypeFilter)
Query for the possible MIME types for the representations the given content URL can be returned when opened as as stream with[openTypedAssetFileDescriptor(Uri, String, Bundle)](/reference/android/content/ContentResolver#openTypedAssetFileDescriptor%28android.net.Uri,%20java.lang.String,%20android.os.Bundle%29). Note that the types here are not necessarily a superset of the type returned by [getType(Uri)](/reference/android/content/ContentResolver#getType%28android.net.Uri%29) -- many content providers cannot return a raw stream for the structured data that they contain.
| Parameters | |
|---|---|
| url | Uri: A Uri identifying content (either a list or specific type), using the content:// scheme. This value cannot be null. |
| mimeTypeFilter | String: The desired MIME type. This may be a pattern, such as */*, to query for all available MIME types that match the pattern. This value cannot be null. |
| Returns | |
|---|---|
| String[] | Returns an array of MIME type strings for all available data streams that match the given mimeTypeFilter. If there are none, null is returned. |
getSyncAdapterTypes
public static SyncAdapterType[] getSyncAdapterTypes ()
Get information about the SyncAdapters that are known to the system.
| Returns | |
|---|---|
| SyncAdapterType[] | an array of SyncAdapters that have registered with the system |
getSyncAutomatically
public static boolean getSyncAutomatically (Account account, String authority)
Check if the provider should be synced when a network tickle is received
This method requires the caller to hold the permission[Manifest.permission.READ_SYNC_SETTINGS](/reference/android/Manifest.permission#READ%5FSYNC%5FSETTINGS).
| Parameters | |
|---|---|
| account | Account: the account whose setting we are querying |
| authority | String: the provider whose setting we are querying |
| Returns | |
|---|---|
| boolean | true if the provider should be synced when a network tickle is received |
getType
public final String getType (Uri url)
Return the MIME type of the given content URL.
| Parameters | |
|---|---|
| url | Uri: A Uri identifying content (either a list or specific type), using the content:// scheme. This value cannot be null. |
| Returns | |
|---|---|
| String | A MIME type for the content, or null if the URL is invalid or the type is unknown |
getTypeInfo
public final ContentResolver.MimeTypeInfo getTypeInfo (String mimeType)
Return a detailed description of the given MIME type, including an icon and label that describe the type.
| Parameters | |
|---|---|
| mimeType | String: Valid, concrete MIME type. This value cannot be null. |
| Returns | |
|---|---|
| ContentResolver.MimeTypeInfo | This value cannot be null. |
insert
public final Uri insert (Uri url, ContentValues values, Bundle extras)
Inserts a row into a table at the given URL. If the content provider supports transactions the insertion will be atomic.
| Parameters | |
|---|---|
| url | Uri: The URL of the table to insert into. This value cannot be null. |
| values | ContentValues: The initial values for the newly inserted row. The key is the column name for the field. Passing an empty ContentValues will create an empty row. This value may be null. |
| extras | Bundle: A Bundle containing additional information necessary for the operation. Arguments may include SQL style arguments, such as ContentResolver.QUERY_ARG_SQL_LIMIT, but note that the documentation for each individual provider will indicate which arguments they support. This value may be null. |
| Returns | |
|---|---|
| Uri | the URL of the newly created row. May return null if the underlying content provider returns null, or if it crashes. |
| Throws | |
|---|---|
| IllegalArgumentException | if the provider doesn't support one of the requested Bundle arguments. |
insert
public final Uri insert (Uri url, ContentValues values)
Inserts a row into a table at the given URL. If the content provider supports transactions the insertion will be atomic.
| Parameters | |
|---|---|
| url | Uri: The URL of the table to insert into. This value cannot be null. |
| values | ContentValues: The initial values for the newly inserted row. The key is the column name for the field. Passing an empty ContentValues will create an empty row. This value may be null. |
| Returns | |
|---|---|
| Uri | the URL of the newly created row. May return null if the underlying content provider returns null, or if it crashes. |
isSyncActive
public static boolean isSyncActive (Account account, String authority)
Returns true if there is currently a sync operation for the given account or authority actively being processed.
This method requires the caller to hold the permission[Manifest.permission.READ_SYNC_STATS](/reference/android/Manifest.permission#READ%5FSYNC%5FSTATS).
| Parameters | |
|---|---|
| account | Account: the account whose setting we are querying |
| authority | String: the provider whose behavior is being queried |
| Returns | |
|---|---|
| boolean | true if a sync is active for the given account or authority. |
isSyncPending
public static boolean isSyncPending (Account account, String authority)
Return true if the pending status is true of any matching authorities.
This method requires the caller to hold the permission[Manifest.permission.READ_SYNC_STATS](/reference/android/Manifest.permission#READ%5FSYNC%5FSTATS).
| Parameters | |
|---|---|
| account | Account: the account whose setting we are querying |
| authority | String: the provider whose behavior is being queried |
| Returns | |
|---|---|
| boolean | true if there is a pending sync with the matching account and authority |
loadThumbnail
public Bitmap loadThumbnail (Uri uri, Size size, CancellationSignal signal)
Convenience method that efficiently loads a visual thumbnail for the given [Uri](/reference/android/net/Uri). Internally calls[ContentProvider.openTypedAssetFile](/reference/android/content/ContentProvider#openTypedAssetFile%28android.net.Uri,%20java.lang.String,%20android.os.Bundle%29) on the remote provider, but also defensively resizes any returned content to match the requested target size.
| Parameters | |
|---|---|
| uri | Uri: The item that should be visualized as a thumbnail. This value cannot be null. |
| size | Size: The target area on the screen where this thumbnail will be shown. This is passed to the provider as EXTRA_SIZE to help it avoid downloading or generating heavy resources. This value cannot be null. |
| signal | CancellationSignal: A signal to cancel the operation in progress. This value may be null. |
| Returns | |
|---|---|
| Bitmap | Valid Bitmap which is a visual thumbnail. This value cannot be null. |
| Throws | |
|---|---|
| IOException | If any trouble was encountered while generating or loading the thumbnail, or ifCancellationSignal.cancel() was invoked. |
notifyChange
public void notifyChange (Uri uri, ContentObserver observer, boolean syncToNetwork)
This method was deprecated in API level 30.
callers should consider migrating to[notifyChange(Uri,ContentObserver,int)](/reference/android/content/ContentResolver#notifyChange%28android.net.Uri,%20android.database.ContentObserver,%20int%29), as it offers support for many more options than just[NOTIFY_SYNC_TO_NETWORK](/reference/android/content/ContentResolver#NOTIFY%5FSYNC%5FTO%5FNETWORK).
Notify registered observers that a row was updated.
To observe events sent through this call, use[registerContentObserver(Uri,boolean,ContentObserver)](/reference/android/content/ContentResolver#registerContentObserver%28android.net.Uri,%20boolean,%20android.database.ContentObserver%29).
If syncToNetwork is true, this will attempt to schedule a local sync using the sync adapter that's registered for the authority of the provided uri. No account will be passed to the sync adapter, so all matching accounts will be synchronized.
Starting in [Build.VERSION_CODES.O](/reference/android/os/Build.VERSION%5FCODES#O), all content notifications must be backed by a valid [ContentProvider](/reference/android/content/ContentProvider).
| Parameters | |
|---|---|
| uri | Uri: The uri of the content that was changed. This value cannot be null. |
| observer | ContentObserver: The observer that originated the change, may benull. The observer that originated the change will only receive the notification if it has requested to receive self-change notifications by implementingContentObserver.deliverSelfNotifications() to return true. |
| syncToNetwork | boolean: If true, same as NOTIFY_SYNC_TO_NETWORK. |
notifyChange
public void notifyChange (Uri uri, ContentObserver observer)
Notify registered observers that a row was updated and attempt to sync changes to the network.
To observe events sent through this call, use[registerContentObserver(Uri,boolean,ContentObserver)](/reference/android/content/ContentResolver#registerContentObserver%28android.net.Uri,%20boolean,%20android.database.ContentObserver%29).
Starting in [Build.VERSION_CODES.O](/reference/android/os/Build.VERSION%5FCODES#O), all content notifications must be backed by a valid [ContentProvider](/reference/android/content/ContentProvider).
| Parameters | |
|---|---|
| uri | Uri: The uri of the content that was changed. This value cannot be null. |
| observer | ContentObserver: The observer that originated the change, may benull. The observer that originated the change will only receive the notification if it has requested to receive self-change notifications by implementingContentObserver.deliverSelfNotifications() to return true. |
openAssetFileDescriptor
public final AssetFileDescriptor openAssetFileDescriptor (Uri uri, String mode, CancellationSignal cancellationSignal)
Open a raw file descriptor to access data under a URI. This interacts with the underlying [ContentProvider.openAssetFile](/reference/android/content/ContentProvider#openAssetFile%28android.net.Uri,%20java.lang.String%29) method of the provider associated with the given URI, to retrieve any file stored there.
Accepts the following URI schemes:
- content (
[SCHEME_CONTENT](/reference/android/content/ContentResolver#SCHEME%5FCONTENT)) - android.resource (
[SCHEME_ANDROID_RESOURCE](/reference/android/content/ContentResolver#SCHEME%5FANDROID%5FRESOURCE)) - file (
[SCHEME_FILE](/reference/android/content/ContentResolver#SCHEME%5FFILE))
The android.resource ([SCHEME_ANDROID_RESOURCE](/reference/android/content/ContentResolver#SCHEME%5FANDROID%5FRESOURCE)) Scheme
A Uri object can be used to reference a resource in an APK file. The Uri should be one of the following formats:
android.resource://package_name/id_numberpackage_nameis your package name as listed in your AndroidManifest.xml. For examplecom.example.myappid_numberis the int form of the ID.
The easiest way to construct this form is
Uri uri = Uri.parse("android.resource://com.example.myapp/" + R.raw.my_resource");android.resource://package_name/type/namepackage_nameis your package name as listed in your AndroidManifest.xml. For examplecom.example.myapptypeis the string form of the resource type. For example,rawordrawable.nameis the string form of the resource name. That is, whatever the file name was in your res directory, without the type extension. The easiest way to construct this form is
Uri uri = Uri.parse("android.resource://com.example.myapp/raw/my_resource");
Note that if this function is called for read-only input (mode is "r") on a content: URI, it will instead call [openTypedAssetFileDescriptor(Uri, String, Bundle)](/reference/android/content/ContentResolver#openTypedAssetFileDescriptor%28android.net.Uri,%20java.lang.String,%20android.os.Bundle%29) for you with a MIME type of "*/*". This allows such callers to benefit from any built-in data conversion that a provider implements.
| Parameters | |
|---|---|
| uri | Uri: The desired URI to open. This value cannot be null. |
| mode | String: The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw" or "rwt". Please note "w" is write only and "wt" is write and truncate. SeeParcelFileDescriptor.parseMode for more details. This value cannot be null. |
| cancellationSignal | CancellationSignal: A signal to cancel the operation in progress, or null if none. If the operation is canceled, thenOperationCanceledException will be thrown. |
| Returns | |
|---|---|
| AssetFileDescriptor | Returns a new ParcelFileDescriptor pointing to the file or null if the provider recently crashed. You own this descriptor and are responsible for closing it when done. |
| Throws | |
|---|---|
| FileNotFoundException | Throws FileNotFoundException of no file exists under the URI or the mode is invalid. |
openAssetFileDescriptor
public final AssetFileDescriptor openAssetFileDescriptor (Uri uri, String mode)
Open a raw file descriptor to access data under a URI. This interacts with the underlying [ContentProvider.openAssetFile](/reference/android/content/ContentProvider#openAssetFile%28android.net.Uri,%20java.lang.String%29) method of the provider associated with the given URI, to retrieve any file stored there.
Accepts the following URI schemes:
- content (
[SCHEME_CONTENT](/reference/android/content/ContentResolver#SCHEME%5FCONTENT)) - android.resource (
[SCHEME_ANDROID_RESOURCE](/reference/android/content/ContentResolver#SCHEME%5FANDROID%5FRESOURCE)) - file (
[SCHEME_FILE](/reference/android/content/ContentResolver#SCHEME%5FFILE))
The android.resource ([SCHEME_ANDROID_RESOURCE](/reference/android/content/ContentResolver#SCHEME%5FANDROID%5FRESOURCE)) Scheme
A Uri object can be used to reference a resource in an APK file. The Uri should be one of the following formats:
android.resource://package_name/id_numberpackage_nameis your package name as listed in your AndroidManifest.xml. For examplecom.example.myappid_numberis the int form of the ID.
The easiest way to construct this form is
Uri uri = Uri.parse("android.resource://com.example.myapp/" + R.raw.my_resource");android.resource://package_name/type/namepackage_nameis your package name as listed in your AndroidManifest.xml. For examplecom.example.myapptypeis the string form of the resource type. For example,rawordrawable.nameis the string form of the resource name. That is, whatever the file name was in your res directory, without the type extension. The easiest way to construct this form is
Uri uri = Uri.parse("android.resource://com.example.myapp/raw/my_resource");
Note that if this function is called for read-only input (mode is "r") on a content: URI, it will instead call [openTypedAssetFileDescriptor(Uri, String, Bundle)](/reference/android/content/ContentResolver#openTypedAssetFileDescriptor%28android.net.Uri,%20java.lang.String,%20android.os.Bundle%29) for you with a MIME type of "*/*". This allows such callers to benefit from any built-in data conversion that a provider implements.
| Parameters | |
|---|---|
| uri | Uri: The desired URI to open. This value cannot be null. |
| mode | String: The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw" or "rwt". Please note the exact implementation of these may differ for each Provider implementation - for example, "w" may or may not truncate. This value cannot be null. |
| Returns | |
|---|---|
| AssetFileDescriptor | Returns a new ParcelFileDescriptor pointing to the file or null if the provider recently crashed. You own this descriptor and are responsible for closing it when done. |
| Throws | |
|---|---|
| FileNotFoundException | Throws FileNotFoundException of no file exists under the URI or the mode is invalid. |
openFileDescriptor
public final ParcelFileDescriptor openFileDescriptor (Uri uri, String mode, CancellationSignal cancellationSignal)
Open a raw file descriptor to access data under a URI. This is like [openAssetFileDescriptor(Uri,String)](/reference/android/content/ContentResolver#openAssetFileDescriptor%28android.net.Uri,%20java.lang.String%29), but uses the underlying [ContentProvider.openFile](/reference/android/content/ContentProvider#openFile%28android.net.Uri,%20java.lang.String%29) ContentProvider.openFile()} method, so will not work with providers that return sub-sections of files. If at all possible, you should use [openAssetFileDescriptor(Uri,String)](/reference/android/content/ContentResolver#openAssetFileDescriptor%28android.net.Uri,%20java.lang.String%29). You will receive a FileNotFoundException exception if the provider returns a sub-section of a file.
Accepts the following URI schemes:
- content (
[SCHEME_CONTENT](/reference/android/content/ContentResolver#SCHEME%5FCONTENT)) - file (
[SCHEME_FILE](/reference/android/content/ContentResolver#SCHEME%5FFILE))
See [openAssetFileDescriptor(Uri,String)](/reference/android/content/ContentResolver#openAssetFileDescriptor%28android.net.Uri,%20java.lang.String%29) for more information on these schemes.
If opening with the exclusive "r" or "w" modes, the returned ParcelFileDescriptor could be a pipe or socket pair to enable streaming of data. Opening with the "rw" mode implies a file on disk that supports seeking. If possible, always use an exclusive mode to give the underlying[ContentProvider](/reference/android/content/ContentProvider) the most flexibility.
If you are writing a file, and need to communicate an error to the provider, use [ParcelFileDescriptor.closeWithError(String)](/reference/android/os/ParcelFileDescriptor#closeWithError%28java.lang.String%29).
| Parameters | |
|---|---|
| uri | Uri: The desired URI to open. This value cannot be null. |
| mode | String: The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw" or "rwt". Please note the exact implementation of these may differ for each Provider implementation - for example, "w" may or may not truncate. This value cannot be null. |
| cancellationSignal | CancellationSignal: A signal to cancel the operation in progress, or null if none. If the operation is canceled, thenOperationCanceledException will be thrown. |
| Returns | |
|---|---|
| ParcelFileDescriptor | Returns a new ParcelFileDescriptor pointing to the file or null if the provider recently crashed. You own this descriptor and are responsible for closing it when done. |
| Throws | |
|---|---|
| FileNotFoundException | Throws FileNotFoundException if no file exists under the URI or the mode is invalid. |
openFileDescriptor
public final ParcelFileDescriptor openFileDescriptor (Uri uri, String mode)
Open a raw file descriptor to access data under a URI. This is like [openAssetFileDescriptor(Uri,String)](/reference/android/content/ContentResolver#openAssetFileDescriptor%28android.net.Uri,%20java.lang.String%29), but uses the underlying [ContentProvider.openFile](/reference/android/content/ContentProvider#openFile%28android.net.Uri,%20java.lang.String%29) ContentProvider.openFile()} method, so will not work with providers that return sub-sections of files. If at all possible, you should use [openAssetFileDescriptor(Uri,String)](/reference/android/content/ContentResolver#openAssetFileDescriptor%28android.net.Uri,%20java.lang.String%29). You will receive a FileNotFoundException exception if the provider returns a sub-section of a file.
Accepts the following URI schemes:
- content (
[SCHEME_CONTENT](/reference/android/content/ContentResolver#SCHEME%5FCONTENT)) - file (
[SCHEME_FILE](/reference/android/content/ContentResolver#SCHEME%5FFILE))
See [openAssetFileDescriptor(Uri,String)](/reference/android/content/ContentResolver#openAssetFileDescriptor%28android.net.Uri,%20java.lang.String%29) for more information on these schemes.
If opening with the exclusive "r" or "w" modes, the returned ParcelFileDescriptor could be a pipe or socket pair to enable streaming of data. Opening with the "rw" mode implies a file on disk that supports seeking. If possible, always use an exclusive mode to give the underlying[ContentProvider](/reference/android/content/ContentProvider) the most flexibility.
If you are writing a file, and need to communicate an error to the provider, use [ParcelFileDescriptor.closeWithError(String)](/reference/android/os/ParcelFileDescriptor#closeWithError%28java.lang.String%29).
| Parameters | |
|---|---|
| uri | Uri: The desired URI to open. This value cannot be null. |
| mode | String: The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw" or "rwt". Please note the exact implementation of these may differ for each Provider implementation - for example, "w" may or may not truncate. This value cannot be null. |
| Returns | |
|---|---|
| ParcelFileDescriptor | Returns a new ParcelFileDescriptor pointing to the file or null if the provider recently crashed. You own this descriptor and are responsible for closing it when done. |
| Throws | |
|---|---|
| FileNotFoundException | Throws FileNotFoundException if no file exists under the URI or the mode is invalid. |
openOutputStream
public final OutputStream openOutputStream (Uri uri)
Synonym for [openOutputStream(uri, "w")](/reference/android/content/ContentResolver#openOutputStream%28android.net.Uri,%20java.lang.String%29). Please note the implementation of "w" is up to each Provider implementation and it may or may not truncate.
| Parameters | |
|---|---|
| uri | Uri: The desired URI. This value cannot be null. |
| Returns | |
|---|---|
| OutputStream | an OutputStream or null if the provider recently crashed. |
| Throws | |
|---|---|
| FileNotFoundException | if the provided URI could not be opened. |
openOutputStream
public final OutputStream openOutputStream (Uri uri, String mode)
Open a stream on to the content associated with a content URI. If there is no data associated with the URI, FileNotFoundException is thrown.
Accepts the following URI schemes:
- content (
[SCHEME_CONTENT](/reference/android/content/ContentResolver#SCHEME%5FCONTENT)) - file (
[SCHEME_FILE](/reference/android/content/ContentResolver#SCHEME%5FFILE))
See [openAssetFileDescriptor(Uri,String)](/reference/android/content/ContentResolver#openAssetFileDescriptor%28android.net.Uri,%20java.lang.String%29) for more information on these schemes.
| Parameters | |
|---|---|
| uri | Uri: The desired URI. This value cannot be null. |
| mode | String: The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw" or "rwt". Please note the exact implementation of these may differ for each Provider implementation - for example, "w" may or may not truncate. This value cannot be null. |
| Returns | |
|---|---|
| OutputStream | an OutputStream or null if the provider recently crashed. |
| Throws | |
|---|---|
| FileNotFoundException | if the provided URI could not be opened. |
openTypedAssetFile
public final AssetFileDescriptor openTypedAssetFile (Uri uri, String mimeTypeFilter, Bundle opts, CancellationSignal signal)
| Parameters | |
|---|---|
| uri | Uri: The desired URI to open. This value cannot be null. |
| mimeTypeFilter | String: The mimetype of data the client desires. This can be a pattern such as */*, if the caller does not have specific type requirements; in this case the content provider will pick its best type matching the pattern. This value cannot be null. |
| opts | Bundle: Additional provider-dependent options like EXTRA_SIZE to indicate the desired size of an image. Whether or not the provider will respect these options is completely provider dependent. This value may be null. |
| signal | CancellationSignal: A signal to cancel the operation in progress or null if none. |
| Returns | |
|---|---|
| AssetFileDescriptor | Returns a new AssetFileDescriptor from which the client can read data of the desired type. This value may be null. |
| Throws |
|---|
| FileNotFoundException |
openTypedAssetFileDescriptor
public final AssetFileDescriptor openTypedAssetFileDescriptor (Uri uri, String mimeType, Bundle opts, CancellationSignal cancellationSignal)
Open a raw file descriptor to access (potentially type transformed) data from a "content:" URI. This interacts with the underlying[ContentProvider.openTypedAssetFile](/reference/android/content/ContentProvider#openTypedAssetFile%28android.net.Uri,%20java.lang.String,%20android.os.Bundle%29) method of the provider associated with the given URI, to retrieve any appropriate data stream for the data stored there.
Unlike [openAssetFileDescriptor(Uri, String)](/reference/android/content/ContentResolver#openAssetFileDescriptor%28android.net.Uri,%20java.lang.String%29), this function only works with "content:" URIs, because content providers are the only facility with an associated MIME type to ensure that the returned data stream is of the desired type.
All text/* streams are encoded in UTF-8.
| Parameters | |
|---|---|
| uri | Uri: The desired URI to open. This value cannot be null. |
| mimeType | String: The desired MIME type of the returned data. This can be a pattern such as */*, which will allow the content provider to select a type, though there is no way for you to determine what type it is returning. This value cannot be null. |
| opts | Bundle: Additional provider-dependent options. This value may be null. |
| cancellationSignal | CancellationSignal: A signal to cancel the operation in progress, or null if none. If the operation is canceled, thenOperationCanceledException will be thrown. |
| Returns | |
|---|---|
| AssetFileDescriptor | Returns a new ParcelFileDescriptor from which you can read the data stream from the provider or null if the provider recently crashed. Note that this may be a pipe, meaning you can't seek in it. The only seek you should do is if the AssetFileDescriptor contains an offset, to move to that offset before reading. You own this descriptor and are responsible for closing it when done. |
| Throws | |
|---|---|
| FileNotFoundException | Throws FileNotFoundException of no data of the desired type exists under the URI. |
openTypedAssetFileDescriptor
public final AssetFileDescriptor openTypedAssetFileDescriptor (Uri uri, String mimeType, Bundle opts)
Open a raw file descriptor to access (potentially type transformed) data from a "content:" URI. This interacts with the underlying[ContentProvider.openTypedAssetFile](/reference/android/content/ContentProvider#openTypedAssetFile%28android.net.Uri,%20java.lang.String,%20android.os.Bundle%29) method of the provider associated with the given URI, to retrieve retrieve any appropriate data stream for the data stored there.
Unlike [openAssetFileDescriptor(Uri, String)](/reference/android/content/ContentResolver#openAssetFileDescriptor%28android.net.Uri,%20java.lang.String%29), this function only works with "content:" URIs, because content providers are the only facility with an associated MIME type to ensure that the returned data stream is of the desired type.
All text/* streams are encoded in UTF-8.
| Parameters | |
|---|---|
| uri | Uri: The desired URI to open. This value cannot be null. |
| mimeType | String: The desired MIME type of the returned data. This can be a pattern such as */*, which will allow the content provider to select a type, though there is no way for you to determine what type it is returning. This value cannot be null. |
| opts | Bundle: Additional provider-dependent options. This value may be null. |
| Returns | |
|---|---|
| AssetFileDescriptor | Returns a new ParcelFileDescriptor from which you can read the data stream from the provider or null if the provider recently crashed. Note that this may be a pipe, meaning you can't seek in it. The only seek you should do is if the AssetFileDescriptor contains an offset, to move to that offset before reading. You own this descriptor and are responsible for closing it when done. |
| Throws | |
|---|---|
| FileNotFoundException | Throws FileNotFoundException of no data of the desired type exists under the URI. |
query
public final Cursor query (Uri uri, String[] projection, Bundle queryArgs, CancellationSignal cancellationSignal)
Query the given URI, returning a [Cursor](/reference/android/database/Cursor) over the result set with support for cancellation.
For best performance, the caller should follow these guidelines:
- Provide an explicit projection, to prevent reading data from storage that aren't going to be used. Provider must identify which QUERY_ARG_SORT* arguments were honored during the preparation of the result set by including the respective argument keys in the
[Cursor](/reference/android/database/Cursor)extras[Bundle](/reference/android/os/Bundle). See[EXTRA_HONORED_ARGS](/reference/android/content/ContentResolver#EXTRA%5FHONORED%5FARGS)for details.Parameters uri Uri: The URI, using the content:// scheme, for the content to retrieve. This value cannot be null. projection String: A list of which columns to return. Passing null will return all columns, which is inefficient. queryArgs Bundle: A Bundle containing additional information necessary for the operation. Arguments may include SQL style arguments, such as ContentResolver.QUERY_ARG_SQL_LIMIT, but note that the documentation for each individual provider will indicate which arguments they support. This value may be null. cancellationSignal CancellationSignal: A signal to cancel the operation in progress, or null if none. If the operation is canceled, then OperationCanceledException will be thrown when the query is executed. Returns -------------------------------------------- ---------------------------------------------------------------------------------------------------------------------------------------------- Cursor A Cursor object, which is positioned before the first entry. May returnnull if the underlying content provider returns null, or if it crashes.
query
public final Cursor query (Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder, CancellationSignal cancellationSignal)
Query the given URI, returning a [Cursor](/reference/android/database/Cursor) over the result set with optional support for cancellation.
For best performance, the caller should follow these guidelines:
- Provide an explicit projection, to prevent reading data from storage that aren't going to be used.
- Use question mark parameter markers such as 'phone=?' instead of explicit values in the
selectionparameter, so that queries that differ only by those values will be recognized as the same for caching purposes.
| Parameters | |
|---|---|
| uri | Uri: The URI, using the content:// scheme, for the content to retrieve. This value cannot be null. |
| projection | String: A list of which columns to return. Passing null will return all columns, which is inefficient. |
| selection | String: A filter declaring which rows to return, formatted as an SQL WHERE clause (excluding the WHERE itself). Passing null will return all rows for the given URI. |
| selectionArgs | String: You may include ?s in selection, which will be replaced by the values from selectionArgs, in the order that they appear in the selection. The values will be bound as Strings. This value may be null. |
| sortOrder | String: How to order the rows, formatted as an SQL ORDER BY clause (excluding the ORDER BY itself). Passing null will use the default sort order, which may be unordered. |
| cancellationSignal | CancellationSignal: A signal to cancel the operation in progress, or null if none. If the operation is canceled, then OperationCanceledException will be thrown when the query is executed. |
| Returns | |
|---|---|
| Cursor | A Cursor object, which is positioned before the first entry. May returnnull if the underlying content provider returns null, or if it crashes. |
query
public final Cursor query (Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)
Query the given URI, returning a [Cursor](/reference/android/database/Cursor) over the result set.
For best performance, the caller should follow these guidelines:
- Provide an explicit projection, to prevent reading data from storage that aren't going to be used.
- Use question mark parameter markers such as 'phone=?' instead of explicit values in the
selectionparameter, so that queries that differ only by those values will be recognized as the same for caching purposes.
| Parameters | |
|---|---|
| uri | Uri: The URI, using the content:// scheme, for the content to retrieve. This value cannot be null. |
| projection | String: A list of which columns to return. Passing null will return all columns, which is inefficient. |
| selection | String: A filter declaring which rows to return, formatted as an SQL WHERE clause (excluding the WHERE itself). Passing null will return all rows for the given URI. |
| selectionArgs | String: You may include ?s in selection, which will be replaced by the values from selectionArgs, in the order that they appear in the selection. The values will be bound as Strings. This value may be null. |
| sortOrder | String: How to order the rows, formatted as an SQL ORDER BY clause (excluding the ORDER BY itself). Passing null will use the default sort order, which may be unordered. |
| Returns | |
|---|---|
| Cursor | A Cursor object, which is positioned before the first entry. May returnnull if the underlying content provider returns null, or if it crashes. |
refresh
public final boolean refresh (Uri url, Bundle extras, CancellationSignal cancellationSignal)
This allows clients to request an explicit refresh of content identified by uri.
Client code should only invoke this method when there is a strong indication (such as a user initiated pull to refresh gesture) that the content is stale.
| Parameters | |
|---|---|
| url | Uri: The Uri identifying the data to refresh. This value cannot be null. |
| extras | Bundle: Additional options from the client. The definitions of these are specific to the content provider being called. This value may be null. |
| cancellationSignal | CancellationSignal: A signal to cancel the operation in progress, or null if none. For example, if you called refresh on a particular uri, you should callCancellationSignal.throwIfCanceled() to check whether the client has canceled the refresh request. |
| Returns | |
|---|---|
| boolean | true if the provider actually tried refreshing. |
registerContentObserver
public final void registerContentObserver (Uri uri, boolean notifyForDescendants, ContentObserver observer)
Register an observer class that gets callbacks when data identified by a given content URI changes.
Starting in [Build.VERSION_CODES.O](/reference/android/os/Build.VERSION%5FCODES#O), all content notifications must be backed by a valid [ContentProvider](/reference/android/content/ContentProvider).
| Parameters | |
|---|---|
| uri | Uri: The URI to watch for changes. This can be a specific row URI, or a base URI for a whole class of content. This value cannot be null. |
| notifyForDescendants | boolean: When false, the observer will be notified whenever a change occurs to the exact URI specified byuri or to one of the URI's ancestors in the path hierarchy. When true, the observer will also be notified whenever a change occurs to the URI's descendants in the path hierarchy. |
| observer | ContentObserver: The object that receives callbacks when changes occur. This value cannot be null. |
removePeriodicSync
public static void removePeriodicSync (Account account, String authority, Bundle extras)
Remove a periodic sync. Has no affect if account, authority and extras don't match an existing periodic sync.
This method requires the caller to hold the permission[Manifest.permission.WRITE_SYNC_SETTINGS](/reference/android/Manifest.permission#WRITE%5FSYNC%5FSETTINGS).
| Parameters | |
|---|---|
| account | Account: the account of the periodic sync to remove |
| authority | String: the provider of the periodic sync to remove |
| extras | Bundle: the extras of the periodic sync to remove |
requestSync
public static void requestSync (Account account, String authority, Bundle extras)
Start an asynchronous sync operation. If you want to monitor the progress of the sync you may register a SyncObserver. Only values of the following types may be used in the extras bundle:
- Integer
- Long
- Boolean
- Float
- Double
- String
- Account
- null
| Parameters | |
|---|---|
| account | Account: which account should be synced |
| authority | String: which authority should be synced |
| extras | Bundle: any extras to pass to the SyncAdapter. |
requestSync
public static void requestSync (SyncRequest request)
Register a sync with the SyncManager. These requests are built using the[SyncRequest.Builder](/reference/android/content/SyncRequest.Builder).
| Parameters | |
|---|---|
| request | SyncRequest |
setIsSyncable
public static void setIsSyncable (Account account, String authority, int syncable)
Set whether this account/provider is syncable.
This method requires the caller to hold the permission[Manifest.permission.WRITE_SYNC_SETTINGS](/reference/android/Manifest.permission#WRITE%5FSYNC%5FSETTINGS).
| Parameters | |
|---|---|
| account | Account |
| authority | String |
| syncable | int: >0 denotes syncable, 0 means not syncable, <0 means unknown |
setMasterSyncAutomatically
public static void setMasterSyncAutomatically (boolean sync)
Sets the global auto-sync setting that applies to all the providers and accounts. If this is false then the per-provider auto-sync setting is ignored.
This method requires the caller to hold the permission[Manifest.permission.WRITE_SYNC_SETTINGS](/reference/android/Manifest.permission#WRITE%5FSYNC%5FSETTINGS).
| Parameters | |
|---|---|
| sync | boolean: the global auto-sync setting that applies to all the providers and accounts |
setSyncAutomatically
public static void setSyncAutomatically (Account account, String authority, boolean sync)
Set whether or not the provider is synced when it receives a network tickle.
This method requires the caller to hold the permission[Manifest.permission.WRITE_SYNC_SETTINGS](/reference/android/Manifest.permission#WRITE%5FSYNC%5FSETTINGS).
| Parameters | |
|---|---|
| account | Account: the account whose setting we are querying |
| authority | String: the provider whose behavior is being controlled |
| sync | boolean: true if the provider should be synced when tickles are received for it |
startSync
public void startSync (Uri uri, Bundle extras)
This method was deprecated in API level 15.
instead use[requestSync(android.accounts.Account,String,android.os.Bundle)](/reference/android/content/ContentResolver#requestSync%28android.accounts.Account,%20java.lang.String,%20android.os.Bundle%29)
Start an asynchronous sync operation. If you want to monitor the progress of the sync you may register a SyncObserver. Only values of the following types may be used in the extras bundle:
- Integer
- Long
- Boolean
- Float
- Double
- String
- Account
- null
| Parameters | |
|---|---|
| uri | Uri: the uri of the provider to sync or null to sync all providers. |
| extras | Bundle: any extras to pass to the SyncAdapter. |
uncanonicalize
public final Uri uncanonicalize (Uri url)
Given a canonical Uri previously generated by [canonicalize(Uri)](/reference/android/content/ContentResolver#canonicalize%28android.net.Uri%29), convert it to its local non-canonical form. This can be useful in some cases where you know that you will only be using the Uri in the current environment and want to avoid any possible overhead when using it with the content provider or want to verify that the referenced data exists at all in the new environment.
| Parameters | |
|---|---|
| url | Uri: The canonical Uri that is to be convered back to its non-canonical form. This value cannot be null. |
| Returns | |
|---|---|
| Uri | Returns the non-canonical representation of url. This will return null if data identified by the canonical Uri can not be found in the current environment; callers must always check for null and deal with that by appropriately falling back to an alternative. |
unregisterContentObserver
public final void unregisterContentObserver (ContentObserver observer)
Unregisters a change observer.
| Parameters | |
|---|---|
| observer | ContentObserver: The previously registered observer that is no longer needed. This value cannot be null. |
update
public final int update (Uri uri, ContentValues values, Bundle extras)
Update row(s) in a content URI. If the content provider supports transactions the update will be atomic.
| Parameters | |
|---|---|
| uri | Uri: The URI to modify. This value cannot be null. |
| values | ContentValues: The new field values. The key is the column name for the field. A null value will remove an existing field value. |
| extras | Bundle: A Bundle containing additional information necessary for the operation. Arguments may include SQL style arguments, such as ContentResolver.QUERY_ARG_SQL_LIMIT, but note that the documentation for each individual provider will indicate which arguments they support. This value may be null. |
| Returns | |
|---|---|
| int | the number of rows updated. |
| Throws | |
|---|---|
| IllegalArgumentException | if the provider doesn't support one of the requested Bundle arguments. |
| NullPointerException | if uri or values are null |
update
public final int update (Uri uri, ContentValues values, String where, String[] selectionArgs)
Update row(s) in a content URI. If the content provider supports transactions the update will be atomic.
| Parameters | |
|---|---|
| uri | Uri: The URI to modify. This value cannot be null. |
| values | ContentValues: The new field values. The key is the column name for the field. A null value will remove an existing field value. |
| where | String: A filter to apply to rows before updating, formatted as an SQL WHERE clause (excluding the WHERE itself). This value may be null. |
| selectionArgs | String: This value may be null. |
| Returns | |
|---|---|
| int | the number of rows updated. |
| Throws | |
|---|---|
| NullPointerException | if uri or values are null |
validateSyncExtrasBundle
public static void validateSyncExtrasBundle (Bundle extras)
Check that only values of the following types are in the Bundle:
- Integer
- Long
- Boolean
- Float
- Double
- String
- Account
- null
| Parameters | |
|---|---|
| extras | Bundle: the Bundle to check |