ContentResolver

ANY_CURSOR_ITEM_TYPE

static val ANY_CURSOR_ITEM_TYPE: String

This is the Android platform's generic MIME type to match any MIME type of the form "CURSOR_ITEM_BASE_TYPE/SUB_TYPE". SUB_TYPE is the sub-type of the application-dependent content, e.g., "audio", "video", "playlist".

Value: "vnd.android.cursor.item/*"

CURSOR_DIR_BASE_TYPE

static val CURSOR_DIR_BASE_TYPE: String

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 URI content://com.company.provider.imap/inbox for all of the messages in its inbox, whose MIME type would be reported as CURSOR_DIR_BASE_TYPE + "/vnd.company.imap-msg"

Note how the base MIME type varies between this and CURSOR_ITEM_BASE_TYPE 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.

Value: "vnd.android.cursor.dir"

CURSOR_ITEM_BASE_TYPE

static val CURSOR_ITEM_BASE_TYPE: String

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 URI content://com.company.provider.imap/inbox/1 for a particular message in the inbox, whose MIME type would be reported as CURSOR_ITEM_BASE_TYPE + "/vnd.company.imap-msg"

Compare with CURSOR_DIR_BASE_TYPE.

Value: "vnd.android.cursor.item"

EXTRA_HONORED_ARGS

static val EXTRA_HONORED_ARGS: String

Allows provider to report back to client which query keys are honored in a Cursor.

Key identifying a String[] containing all QUERY_ARG_SORT* arguments honored by the provider. Include this in Cursor extras Bundle when any QUERY_ARG_SORT* value was honored during the preparation of the results Cursor.

If present, ALL honored arguments are enumerated in this extra’s payload.

Value: "android.content.extra.HONORED_ARGS"

EXTRA_REFRESH_SUPPORTED

static val EXTRA_REFRESH_SUPPORTED: String

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.

Value: "android.content.extra.REFRESH_SUPPORTED"

EXTRA_SIZE

static val EXTRA_SIZE: String

An extra Point describing the optimal size for a requested image resource, in pixels. If a provider has multiple sizes of the image, it should return the image closest to this size.

Value: "android.content.extra.SIZE"

EXTRA_TOTAL_COUNT

static val EXTRA_TOTAL_COUNT: String

Added to Cursor extras 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.

Value: "android.content.extra.TOTAL_COUNT"

NOTIFY_DELETE

static val NOTIFY_DELETE: Int

Flag for notifyChange(android.net.Uri,android.database.ContentObserver,int): typically set by a ContentProvider to indicate that this notification is the result of a android.content.ContentProvider#delete call.

Sending these detailed flags are optional, but providers are strongly recommended to send them.

Value: 16

NOTIFY_INSERT

static val NOTIFY_INSERT: Int

Flag for notifyChange(android.net.Uri,android.database.ContentObserver,int): typically set by a ContentProvider to indicate that this notification is the result of an android.content.ContentProvider#insert call.

Sending these detailed flags are optional, but providers are strongly recommended to send them.

Value: 4

NOTIFY_SKIP_NOTIFY_FOR_DESCENDANTS

static val NOTIFY_SKIP_NOTIFY_FOR_DESCENDANTS: Int

Flag for notifyChange(android.net.Uri,android.database.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. It would use this flag when sending the former, so that observers of "X and descendants" only see the latter.

Value: 2

NOTIFY_SYNC_TO_NETWORK

static val NOTIFY_SYNC_TO_NETWORK: Int

Flag for notifyChange(android.net.Uri,android.database.ContentObserver,int): attempt to sync the change to the network.

Value: 1

NOTIFY_UPDATE

static val NOTIFY_UPDATE: Int

Flag for notifyChange(android.net.Uri,android.database.ContentObserver,int): typically set by a ContentProvider to indicate that this notification is the result of an android.content.ContentProvider#update call.

Sending these detailed flags are optional, but providers are strongly recommended to send them.

Value: 8

QUERY_ARG_GROUP_COLUMNS

static val QUERY_ARG_GROUP_COLUMNS: String

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).

Apps targeting android.os.Build.VERSION_CODES#R or higher:

Value: "android:query-arg-group-columns"

QUERY_ARG_LIMIT

static val QUERY_ARG_LIMIT: String

Specifies the max number of rows to include in a Cursor.

Value: "android:query-arg-limit"

QUERY_ARG_OFFSET

static val QUERY_ARG_OFFSET: String

Specifies the offset row index within a Cursor.

Value: "android:query-arg-offset"

QUERY_ARG_SORT_COLLATION

static val QUERY_ARG_SORT_COLLATION: String

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 implementations: When preparing data in ContentProvider#query(Uri, String[], Bundle, CancellationSignal), if sort collation is reflected in the returned Cursor, it is strongly recommended that QUERY_ARG_SORT_COLLATION then be included in the array of honored arguments reflected in Cursor extras Bundle under EXTRA_HONORED_ARGS.

When querying a provider, where no QUERY_ARG_SQL* otherwise exists in the arguments Bundle, the Content framework will attempt to synthesize a QUERY_ARG_SQL* argument using the corresponding QUERY_ARG_SORT* values.

Value: "android:query-arg-sort-collation"

QUERY_ARG_SORT_COLUMNS

static val QUERY_ARG_SORT_COLUMNS: String

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).

Apps targeting android.os.Build.VERSION_CODES#O or higher:

Value: "android:query-arg-sort-columns"

QUERY_ARG_SORT_DIRECTION

static val QUERY_ARG_SORT_DIRECTION: String

Specifies desired sort order. When unspecified a provider may provide a default sort direction, or choose to return unsorted results.

Apps targeting android.os.Build.VERSION_CODES#O or higher:

Value: "android:query-arg-sort-direction"

QUERY_ARG_SORT_LOCALE

static val QUERY_ARG_SORT_LOCALE: String

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 android.icu.util.ULocale. This supports requesting advanced sorting options, such as de@collation=phonebook, zh@collation=pinyin, etc.

ContentProvider implementations: When preparing data in ContentProvider#query(Uri, String[], Bundle, CancellationSignal), if sort locale is reflected in the returned Cursor, it is strongly recommended that QUERY_ARG_SORT_LOCALE then be included in the array of honored arguments reflected in Cursor extras Bundle under EXTRA_HONORED_ARGS.

Value: "android:query-arg-sort-locale"

QUERY_ARG_SQL_GROUP_BY

static val QUERY_ARG_SQL_GROUP_BY: String

Key for an SQL style GROUP BY string that may be present in the query Bundle argument passed to ContentProvider#query(Uri, String[], Bundle, CancellationSignal).

Apps targeting android.os.Build.VERSION_CODES#O or higher are strongly encourage to use structured query arguments in lieu of opaque SQL query clauses.

Value: "android:query-arg-sql-group-by"

QUERY_ARG_SQL_HAVING

static val QUERY_ARG_SQL_HAVING: String

Key for an SQL style HAVING string that may be present in the query Bundle argument passed to ContentProvider#query(Uri, String[], Bundle, CancellationSignal).

Apps targeting android.os.Build.VERSION_CODES#O or higher are strongly encourage to use structured query arguments in lieu of opaque SQL query clauses.

Value: "android:query-arg-sql-having"

QUERY_ARG_SQL_LIMIT

static val QUERY_ARG_SQL_LIMIT: String

Key for an SQL style LIMIT string that may be present in the query Bundle argument passed to ContentProvider#query(Uri, String[], Bundle, CancellationSignal).

Apps targeting android.os.Build.VERSION_CODES#O or higher are strongly encourage to use structured query arguments in lieu of opaque SQL query clauses.

Value: "android:query-arg-sql-limit"

QUERY_ARG_SQL_SELECTION

static val QUERY_ARG_SQL_SELECTION: String

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.

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 {@value #QUERY_ARG_SQL_SELECTION_ARGS}.

Apps targeting android.os.Build.VERSION_CODES#O or higher are strongly encourage to use structured query arguments in lieu of opaque SQL query clauses.

Value: "android:query-arg-sql-selection"

QUERY_ARG_SQL_SELECTION_ARGS

static val QUERY_ARG_SQL_SELECTION_ARGS: String

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 {@value #QUERY_ARG_SQL_SELECTION_ARGS}.

Apps targeting android.os.Build.VERSION_CODES#O or higher are strongly encourage to use structured query arguments in lieu of opaque SQL query clauses.

Value: "android:query-arg-sql-selection-args"

QUERY_ARG_SQL_SORT_ORDER

static val QUERY_ARG_SQL_SORT_ORDER: String

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.

Apps targeting android.os.Build.VERSION_CODES#O or higher are strongly encourage to use structured query arguments in lieu of opaque SQL query clauses.

Value: "android:query-arg-sql-sort-order"

QUERY_SORT_DIRECTION_ASCENDING

static val QUERY_SORT_DIRECTION_ASCENDING: Int

Value: 0

QUERY_SORT_DIRECTION_DESCENDING

static val QUERY_SORT_DIRECTION_DESCENDING: Int

Value: 1

SCHEME_ANDROID_RESOURCE

static val SCHEME_ANDROID_RESOURCE: String

Value: "android.resource"

SCHEME_CONTENT

static val SCHEME_CONTENT: String

Value: "content"

SCHEME_FILE

static val SCHEME_FILE: String

Value: "file"

SYNC_EXTRAS_ACCOUNT

static val SYNC_EXTRAS_ACCOUNT: String

Deprecated: instead use requestSync(android.accounts.Account,java.lang.String,android.os.Bundle)

Value: "account"

SYNC_EXTRAS_DISCARD_LOCAL_DELETIONS

static val SYNC_EXTRAS_DISCARD_LOCAL_DELETIONS: String

Indicates that the sync adapter should not proceed with the delete operations, if it determines that there are too many. See SyncResult#tooManyDeletions

Value: "discard_deletions"

SYNC_EXTRAS_DO_NOT_RETRY

static val SYNC_EXTRAS_DO_NOT_RETRY: String

If this extra is set to true then the request will not be retried if it fails.

Value: "do_not_retry"

SYNC_EXTRAS_EXPEDITED

static val SYNC_EXTRAS_EXPEDITED: String

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.

Value: "expedited"

SYNC_EXTRAS_FORCE

static val SYNC_EXTRAS_FORCE: String

Deprecated: instead use SYNC_EXTRAS_MANUAL

Value: "force"

SYNC_EXTRAS_IGNORE_BACKOFF

static val SYNC_EXTRAS_IGNORE_BACKOFF: String

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.

Value: "ignore_backoff"

SYNC_EXTRAS_IGNORE_SETTINGS

static val SYNC_EXTRAS_IGNORE_SETTINGS: String

If this extra is set to true then the sync settings (like getSyncAutomatically()) are ignored by the sync scheduler.

Value: "ignore_settings"

SYNC_EXTRAS_INITIALIZE

static val SYNC_EXTRAS_INITIALIZE: String

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,java.lang.String,int) 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.

Value: "initialize"

SYNC_EXTRAS_MANUAL

static val SYNC_EXTRAS_MANUAL: String

Setting this extra is the equivalent of setting both SYNC_EXTRAS_IGNORE_SETTINGS and SYNC_EXTRAS_IGNORE_BACKOFF

Value: "force"

SYNC_EXTRAS_OVERRIDE_TOO_MANY_DELETIONS

static val SYNC_EXTRAS_OVERRIDE_TOO_MANY_DELETIONS: String

Indicates that the sync adapter should proceed with the delete operations, even if it determines that there are too many. See SyncResult#tooManyDeletions

Value: "deletions_override"

SYNC_EXTRAS_REQUIRE_CHARGING

static val SYNC_EXTRAS_REQUIRE_CHARGING: String

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.

Value: "require_charging"

SYNC_EXTRAS_SCHEDULE_AS_EXPEDITED_JOB

static val SYNC_EXTRAS_SCHEDULE_AS_EXPEDITED_JOB: String

Run this sync operation as an "expedited job" (see android.app.job.JobInfo.Builder#setExpedited(boolean)). Normally (if this flag isn't specified), sync operations are executed as regular 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 an IllegalArgumentException 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
• Can't be used with SYNC_EXTRAS_EXPEDITED
• 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 is set.

This is different from SYNC_EXTRAS_EXPEDITED.

Value: "schedule_as_expedited_job"

SYNC_EXTRAS_UPLOAD

static val SYNC_EXTRAS_UPLOAD: String

Indicates that this sync is intended to only upload local changes to the server. For example, this will be set to true if the sync is initiated by a call to ContentResolver#notifyChange(android.net.Uri, android.database.ContentObserver, boolean)

Value: "upload"

SYNC_OBSERVER_TYPE_ACTIVE

static val SYNC_OBSERVER_TYPE_ACTIVE: Int

Value: 4

SYNC_OBSERVER_TYPE_PENDING

static val SYNC_OBSERVER_TYPE_PENDING: Int

Value: 2

SYNC_OBSERVER_TYPE_SETTINGS

static val SYNC_OBSERVER_TYPE_SETTINGS: Int

Value: 1

ContentResolver

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.

acquireContentProviderClient

fun acquireContentProviderClient(uri: Uri): ContentProviderClient?

Returns a ContentProviderClient that is associated with the 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 which will allow the system to release the provider if it determines that there is no other reason for keeping it active.

acquireContentProviderClient

fun acquireContentProviderClient(name: String): ContentProviderClient?

Returns a ContentProviderClient that is associated with the 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 which will allow the system to release the provider if it determines that there is no other reason for keeping it active.

acquireUnstableContentProviderClient

fun acquireUnstableContentProviderClient(uri: Uri): ContentProviderClient?

Like acquireContentProviderClient(android.net.Uri), 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 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.

acquireUnstableContentProviderClient

fun acquireUnstableContentProviderClient(name: String): ContentProviderClient?

Like acquireContentProviderClient(java.lang.String), 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 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.

addPeriodicSync

open static fun addPeriodicSync(
    account: Account!, 
    authority: String!, 
    extras: Bundle!, 
    pollFrequency: Long
): Unit

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, SYNC_EXTRAS_IGNORE_BACKOFF, SYNC_EXTRAS_IGNORE_SETTINGS, SYNC_EXTRAS_INITIALIZE, SYNC_EXTRAS_FORCE, SYNC_EXTRAS_EXPEDITED, SYNC_EXTRAS_MANUAL, SYNC_EXTRAS_SCHEDULE_AS_EXPEDITED_JOB set to true. If any are supplied then an IllegalArgumentException will be thrown.

This method requires the caller to hold the permission android.Manifest.permission#WRITE_SYNC_SETTINGS.

The bundle for a periodic sync can be queried by applications with the correct permissions using ContentResolver#getPeriodicSyncs(Account account, String provider), so no sensitive data should be transferred here.

addStatusChangeListener

open static fun addStatusChangeListener(
    mask: Int, 
    callback: SyncStatusObserver!
): Any!

Request notifications when the different aspects of the SyncManager change. The different items that can be requested are:

• SYNC_OBSERVER_TYPE_PENDING
• SYNC_OBSERVER_TYPE_ACTIVE
• SYNC_OBSERVER_TYPE_SETTINGS

applyBatch

open fun applyBatch(
    authority: String, 
    operations: ArrayList<ContentProviderOperation!>
): Array<ContentProviderResult!>

Applies each of the ContentProviderOperation objects and returns an array of their results. Passes through OperationApplicationException, which may be thrown by the call to ContentProviderOperation#apply. If all the applications succeed then a ContentProviderResult array with the same number of elements as the operations will be returned. It is implementation-specific how many, if any, operations will have been successfully applied if a call to apply results in a OperationApplicationException.

bulkInsert

fun bulkInsert(
    url: Uri, 
    values: Array<ContentValues!>
): Int

Inserts multiple rows into a table at the given URL. This function make no guarantees about the atomicity of the insertions.

call

fun call(
    uri: Uri, 
    method: String, 
    arg: String?, 
    extras: Bundle?
): Bundle?

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.

call

fun call(
    authority: String, 
    method: String, 
    arg: String?, 
    extras: Bundle?
): Bundle?

cancelSync

open fun cancelSync(uri: Uri!): Unit

Deprecated: instead use cancelSync(android.accounts.Account,java.lang.String)

Cancel any active or pending syncs that match the Uri. If the uri is null then all syncs will be canceled.

cancelSync

open static fun cancelSync(
    account: Account!, 
    authority: String!
): Unit

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.

cancelSync

open static fun cancelSync(request: SyncRequest!): Unit

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 android.Manifest.permission#WRITE_SYNC_SETTINGS.

canonicalize

fun canonicalize(url: Uri): Uri?

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, openInputStream(android.net.Uri), 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 with that original Uri to re-canonicalize it for the current environment. Alternatively, you may want to use uncanonicalize to transform it to a non-canonical Uri that works only in the current environment but potentially more efficiently than the canonical representation.

delete

fun delete(
    url: Uri, 
    where: String?, 
    selectionArgs: Array<String!>?
): Int

Deletes row(s) specified by a content URI. If the content provider supports transactions, the deletion will be atomic.

delete

fun delete(
    url: Uri, 
    extras: Bundle?
): Int

Deletes row(s) specified by a content URI. If the content provider supports transactions, the deletion will be atomic.

getCurrentSync

open static fun getCurrentSync(): SyncInfo!

Deprecated: Since multiple concurrent syncs are now supported you should use getCurrentSyncs() 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 android.Manifest.permission#READ_SYNC_STATS.

getCurrentSyncs

open static fun getCurrentSyncs(): MutableList<SyncInfo!>!

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 android.Manifest.permission#READ_SYNC_STATS.

getIsSyncable

open static fun getIsSyncable(
    account: Account!, 
    authority: String!
): Int

Check if this account/provider is syncable.

This method requires the caller to hold the permission android.Manifest.permission#READ_SYNC_SETTINGS.

getMasterSyncAutomatically

open static fun getMasterSyncAutomatically(): Boolean

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 android.Manifest.permission#READ_SYNC_SETTINGS.

getOutgoingPersistedUriPermissions

open fun getOutgoingPersistedUriPermissions(): MutableList<UriPermission!>

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(android.net.Uri,int) are returned.

Note: Some of the returned URIs may not be usable until after the user is unlocked.

getPeriodicSyncs

open static fun getPeriodicSyncs(
    account: Account!, 
    authority: String!
): MutableList<PeriodicSync!>!

Get the list of information about the periodic syncs for the given account and authority.

This method requires the caller to hold the permission android.Manifest.permission#READ_SYNC_SETTINGS.

getPersistedUriPermissions

open fun getPersistedUriPermissions(): MutableList<UriPermission!>

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(android.net.Uri,int) are returned.

Note: Some of the returned URIs may not be usable until after the user is unlocked.

getStreamTypes

open fun getStreamTypes(
    url: Uri, 
    mimeTypeFilter: String
): Array<String!>?

Query for the possible MIME types for the representations the given content URL can be returned when opened as as stream with #openTypedAssetFileDescriptor. Note that the types here are not necessarily a superset of the type returned by getType -- many content providers cannot return a raw stream for the structured data that they contain.

getSyncAdapterTypes

open static fun getSyncAdapterTypes(): Array<SyncAdapterType!>!

Get information about the SyncAdapters that are known to the system.

getSyncAutomatically

open static fun getSyncAutomatically(
    account: Account!, 
    authority: String!
): Boolean

Check if the provider should be synced when a network tickle is received

This method requires the caller to hold the permission android.Manifest.permission#READ_SYNC_SETTINGS.

getType

fun getType(url: Uri): String?

Return the MIME type of the given content URL.

getTypeInfo

fun getTypeInfo(mimeType: String): ContentResolver.MimeTypeInfo

Return a detailed description of the given MIME type, including an icon and label that describe the type.

insert

fun insert(
    url: Uri, 
    values: ContentValues?
): Uri?

Inserts a row into a table at the given URL. If the content provider supports transactions the insertion will be atomic.

insert

fun insert(
    url: Uri, 
    values: ContentValues?, 
    extras: Bundle?
): Uri?

Inserts a row into a table at the given URL. If the content provider supports transactions the insertion will be atomic.

isSyncActive

open static fun isSyncActive(
    account: Account!, 
    authority: String!
): Boolean

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 android.Manifest.permission#READ_SYNC_STATS.

isSyncPending

open static fun isSyncPending(
    account: Account!, 
    authority: String!
): Boolean

Return true if the pending status is true of any matching authorities.

This method requires the caller to hold the permission android.Manifest.permission#READ_SYNC_STATS.

loadThumbnail

open fun loadThumbnail(
    uri: Uri, 
    size: Size, 
    signal: CancellationSignal?
): Bitmap

Convenience method that efficiently loads a visual thumbnail for the given Uri. Internally calls android.content.ContentProvider#openTypedAssetFile on the remote provider, but also defensively resizes any returned content to match the requested target size.

notifyChange

open fun notifyChange(
    uri: Uri, 
    observer: ContentObserver?
): Unit

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(android.net.Uri,boolean,android.database.ContentObserver).

Starting in android.os.Build.VERSION_CODES#O, all content notifications must be backed by a valid ContentProvider.

notifyChange

open fun notifyChange(
    uri: Uri, 
    observer: ContentObserver?, 
    syncToNetwork: Boolean
): Unit

Deprecated: callers should consider migrating to notifyChange(android.net.Uri,android.database.ContentObserver,int), as it offers support for many more options than just NOTIFY_SYNC_TO_NETWORK.

Notify registered observers that a row was updated.

To observe events sent through this call, use registerContentObserver(android.net.Uri,boolean,android.database.ContentObserver).

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 android.os.Build.VERSION_CODES#O, all content notifications must be backed by a valid ContentProvider.

notifyChange

open fun notifyChange(
    uri: Uri, 
    observer: ContentObserver?, 
    flags: Int
): Unit

Notify registered observers that a row was updated.

To observe events sent through this call, use registerContentObserver(android.net.Uri,boolean,android.database.ContentObserver).

If NOTIFY_SYNC_TO_NETWORK is set, 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 android.os.Build.VERSION_CODES#O, all content notifications must be backed by a valid ContentProvider.

notifyChange

open fun notifyChange(
    uris: MutableCollection<Uri!>, 
    observer: ContentObserver?, 
    flags: Int
): Unit

Notify registered observers that several rows have been updated.

To observe events sent through this call, use registerContentObserver(android.net.Uri,boolean,android.database.ContentObserver).

If NOTIFY_SYNC_TO_NETWORK is set, 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 android.os.Build.VERSION_CODES#O, all content notifications must be backed by a valid ContentProvider.

openAssetFile

fun openAssetFile(
    uri: Uri, 
    mode: String, 
    signal: CancellationSignal?
): AssetFileDescriptor?

openAssetFileDescriptor

fun openAssetFileDescriptor(
    uri: Uri, 
    mode: String
): AssetFileDescriptor?

Open a raw file descriptor to access data under a URI. This interacts with the underlying android.content.ContentProvider#openAssetFile method of the provider associated with the given URI, to retrieve any file stored there.

Accepts the following URI schemes:

• content (SCHEME_CONTENT)
• android.resource (SCHEME_ANDROID_RESOURCE)
• file (SCHEME_FILE)

The android.resource (SCHEME_ANDROID_RESOURCE) 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_number
package_name is your package name as listed in your AndroidManifest.xml. For example com.example.myapp
id_number is 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/name
package_name is your package name as listed in your AndroidManifest.xml. For example com.example.myapp
type is the string form of the resource type. For example, raw or drawable. name is 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 for you with a MIME type of "*/*". This allows such callers to benefit from any built-in data conversion that a provider implements.

openAssetFileDescriptor

fun openAssetFileDescriptor(
    uri: Uri, 
    mode: String, 
    cancellationSignal: CancellationSignal?
): AssetFileDescriptor?

Open a raw file descriptor to access data under a URI. This interacts with the underlying android.content.ContentProvider#openAssetFile method of the provider associated with the given URI, to retrieve any file stored there.

Accepts the following URI schemes:

• content (SCHEME_CONTENT)
• android.resource (SCHEME_ANDROID_RESOURCE)
• file (SCHEME_FILE)

The android.resource (SCHEME_ANDROID_RESOURCE) 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_number
package_name is your package name as listed in your AndroidManifest.xml. For example com.example.myapp
id_number is 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/name
package_name is your package name as listed in your AndroidManifest.xml. For example com.example.myapp
type is the string form of the resource type. For example, raw or drawable. name is 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 for you with a MIME type of "*/*". This allows such callers to benefit from any built-in data conversion that a provider implements.

openFile

fun openFile(
    uri: Uri, 
    mode: String, 
    signal: CancellationSignal?
): ParcelFileDescriptor?

openFileDescriptor

fun openFileDescriptor(
    uri: Uri, 
    mode: String
): ParcelFileDescriptor?

Open a raw file descriptor to access data under a URI. This is like openAssetFileDescriptor(android.net.Uri,java.lang.String), but uses the underlying android.content.ContentProvider#openFile ContentProvider.openFile()} method, so will not work with providers that return sub-sections of files. If at all possible, you should use openAssetFileDescriptor(android.net.Uri,java.lang.String). You will receive a FileNotFoundException exception if the provider returns a sub-section of a file.

Accepts the following URI schemes:

• content (SCHEME_CONTENT)
• file (SCHEME_FILE)

See openAssetFileDescriptor(android.net.Uri,java.lang.String) 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 the most flexibility.

If you are writing a file, and need to communicate an error to the provider, use ParcelFileDescriptor#closeWithError(String).

openFileDescriptor

fun openFileDescriptor(
    uri: Uri, 
    mode: String, 
    cancellationSignal: CancellationSignal?
): ParcelFileDescriptor?

Open a raw file descriptor to access data under a URI. This is like openAssetFileDescriptor(android.net.Uri,java.lang.String), but uses the underlying android.content.ContentProvider#openFile ContentProvider.openFile()} method, so will not work with providers that return sub-sections of files. If at all possible, you should use openAssetFileDescriptor(android.net.Uri,java.lang.String). You will receive a FileNotFoundException exception if the provider returns a sub-section of a file.

Accepts the following URI schemes:

• content (SCHEME_CONTENT)
• file (SCHEME_FILE)

See openAssetFileDescriptor(android.net.Uri,java.lang.String) 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 the most flexibility.

If you are writing a file, and need to communicate an error to the provider, use ParcelFileDescriptor#closeWithError(String).

openInputStream

fun openInputStream(uri: Uri): InputStream?

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)
• android.resource (SCHEME_ANDROID_RESOURCE)
• file (SCHEME_FILE)

See openAssetFileDescriptor(android.net.Uri,java.lang.String) for more information on these schemes.

openOutputStream

fun openOutputStream(uri: Uri): OutputStream?

Synonym for openOutputStream(uri, "w"). Please note the implementation of "w" is up to each Provider implementation and it may or may not truncate.

openOutputStream

fun openOutputStream(
    uri: Uri, 
    mode: String
): OutputStream?

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)
• file (SCHEME_FILE)

See openAssetFileDescriptor(android.net.Uri,java.lang.String) for more information on these schemes.

openTypedAssetFile

fun openTypedAssetFile(
    uri: Uri, 
    mimeTypeFilter: String, 
    opts: Bundle?, 
    signal: CancellationSignal?
): AssetFileDescriptor?

openTypedAssetFileDescriptor

fun openTypedAssetFileDescriptor(
    uri: Uri, 
    mimeType: String, 
    opts: Bundle?
): AssetFileDescriptor?

Open a raw file descriptor to access (potentially type transformed) data from a "content:" URI. This interacts with the underlying android.content.ContentProvider#openTypedAssetFile method of the provider associated with the given URI, to retrieve retrieve any appropriate data stream for the data stored there.

Unlike #openAssetFileDescriptor, 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.

openTypedAssetFileDescriptor

fun openTypedAssetFileDescriptor(
    uri: Uri, 
    mimeType: String, 
    opts: Bundle?, 
    cancellationSignal: CancellationSignal?
): AssetFileDescriptor?

Open a raw file descriptor to access (potentially type transformed) data from a "content:" URI. This interacts with the underlying android.content.ContentProvider#openTypedAssetFile method of the provider associated with the given URI, to retrieve any appropriate data stream for the data stored there.

Unlike #openAssetFileDescriptor, 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.

query

fun query(
    uri: Uri, 
    projection: Array<String!>?, 
    selection: String?, 
    selectionArgs: Array<String!>?, 
    sortOrder: String?
): Cursor?

Query the given URI, returning a 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 selection parameter, so that queries that differ only by those values will be recognized as the same for caching purposes.

query

fun query(
    uri: Uri, 
    projection: Array<String!>?, 
    selection: String?, 
    selectionArgs: Array<String!>?, 
    sortOrder: String?, 
    cancellationSignal: CancellationSignal?
): Cursor?

Query the given URI, returning a 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 selection parameter, so that queries that differ only by those values will be recognized as the same for caching purposes.

query

fun query(
    uri: Uri, 
    projection: Array<String!>?, 
    queryArgs: Bundle?, 
    cancellationSignal: CancellationSignal?
): Cursor?

Query the given URI, returning a Cursor over the result set with support for cancellation.

For best performance, the caller should follow these guidelines:

refresh

fun refresh(
    url: Uri, 
    extras: Bundle?, 
    cancellationSignal: CancellationSignal?
): Boolean

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.

registerContentObserver

fun registerContentObserver(
    uri: Uri, 
    notifyForDescendants: Boolean, 
    observer: ContentObserver
): Unit

Register an observer class that gets callbacks when data identified by a given content URI changes.

Starting in android.os.Build.VERSION_CODES#O, all content notifications must be backed by a valid ContentProvider.

releasePersistableUriPermission

open fun releasePersistableUriPermission(
    uri: Uri, 
    modeFlags: Int
): Unit

Relinquish a persisted URI permission grant. The URI must have been previously made persistent with takePersistableUriPermission(android.net.Uri,int). Any non-persistent grants to the calling package will remain intact.

removePeriodicSync

open static fun removePeriodicSync(
    account: Account!, 
    authority: String!, 
    extras: Bundle!
): Unit

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 android.Manifest.permission#WRITE_SYNC_SETTINGS.

removeStatusChangeListener

open static fun removeStatusChangeListener(handle: Any!): Unit

Remove a previously registered status change listener.

requestSync

open static fun requestSync(
    account: Account!, 
    authority: String!, 
    extras: Bundle!
): Unit

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

requestSync

open static fun requestSync(request: SyncRequest!): Unit

Register a sync with the SyncManager. These requests are built using the SyncRequest.Builder.

setIsSyncable

open static fun setIsSyncable(
    account: Account!, 
    authority: String!, 
    syncable: Int
): Unit

Set whether this account/provider is syncable.

This method requires the caller to hold the permission android.Manifest.permission#WRITE_SYNC_SETTINGS.

setMasterSyncAutomatically

open static fun setMasterSyncAutomatically(sync: Boolean): Unit

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 android.Manifest.permission#WRITE_SYNC_SETTINGS.

setSyncAutomatically

open static fun setSyncAutomatically(
    account: Account!, 
    authority: String!, 
    sync: Boolean
): Unit

Set whether or not the provider is synced when it receives a network tickle.

This method requires the caller to hold the permission android.Manifest.permission#WRITE_SYNC_SETTINGS.

startSync

open fun startSync(
    uri: Uri!, 
    extras: Bundle!
): Unit

Deprecated: instead use requestSync(android.accounts.Account,java.lang.String,android.os.Bundle)

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

takePersistableUriPermission

open fun takePersistableUriPermission(
    uri: Uri, 
    modeFlags: Int
): Unit

Take a persistable URI permission grant that has been offered. Once taken, the permission grant will be remembered across device reboots. Only URI permissions granted with Intent#FLAG_GRANT_PERSISTABLE_URI_PERMISSION can be persisted. If the grant has already been persisted, taking it again will touch UriPermission#getPersistedTime().

uncanonicalize

fun uncanonicalize(url: Uri): Uri?

Given a canonical Uri previously generated by canonicalize, 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.

unregisterContentObserver

fun unregisterContentObserver(observer: ContentObserver): Unit

Unregisters a change observer.

update

fun update(
    uri: Uri, 
    values: ContentValues?, 
    where: String?, 
    selectionArgs: Array<String!>?
): Int

Update row(s) in a content URI. If the content provider supports transactions the update will be atomic.

update

fun update(
    uri: Uri, 
    values: ContentValues?, 
    extras: Bundle?
): Int