Added in API level 33
Also in R Extensions 3

CloudMediaProvider

---

Kotlin |Java

abstract class CloudMediaProvider : ContentProvider

kotlin.Any
↳	android.content.ContentProvider
	↳	android.provider.CloudMediaProvider

Base class for a cloud media provider. A cloud media provider offers read-only access to durable media files, specifically photos and videos stored on a local disk, or files in a cloud storage service. To create a cloud media provider, extend this class, implement the abstract methods, and add it to your manifest like this:

<manifest>
     ...
     <application>
         ...
         <provider
             android:name="com.example.MyCloudProvider"
             android:authorities="com.example.mycloudprovider"
             android:exported="true"
             android:permission="com.android.providers.media.permission.MANAGE_CLOUD_MEDIA_PROVIDERS"
             <intent-filter>
                 <action android:name="android.content.action.CLOUD_MEDIA_PROVIDER" />
             </intent-filter>
         </provider>
         ...
     </application>
 </manifest>

When defining your provider, you must protect it with the CloudMediaProviderContract.MANAGE_CLOUD_MEDIA_PROVIDERS_PERMISSION, which is a permission only the system can obtain, trying to define an unprotected CloudMediaProvider will result in a SecurityException.

Applications cannot use a cloud media provider directly; they must go through MediaStore.ACTION_PICK_IMAGES which requires a user to actively navigate and select media items. When a user selects a media item through that UI, the system issues narrow URI permission grants to the requesting application.

Media items

A media item must be an openable stream (with a specific MIME type). Media items can belong to zero or more albums. Albums cannot contain other albums.

Each item under a provider is uniquely referenced by its media or album id, which must not change which must be unique across all collection IDs as returned by onGetMediaCollectionInfo.

Summary

Nested classes
abstract	CloudMediaSurfaceController Manages rendering the preview of media items on given instances of Surface.
	CloudMediaSurfaceStateChangedCallback This class is used by CloudMediaProvider to send Surface state updates to picker launched via MediaStore.ACTION_PICK_IMAGES.

Inherited constants

From class ComponentCallbacks2 Int TRIM_MEMORY_BACKGROUND Level for onTrimMemory(int): the process has gone on to the LRU list. This is a good opportunity to clean up resources that can efficiently and quickly be re-built if the user returns to the app. Int TRIM_MEMORY_COMPLETE Level for onTrimMemory(int): the process is nearing the end of the background LRU list, and if more memory isn't found soon it will be killed. Int TRIM_MEMORY_MODERATE Level for onTrimMemory(int): the process is around the middle of the background LRU list; freeing memory can help the system keep other processes running later in the list for better overall performance. Int TRIM_MEMORY_RUNNING_CRITICAL Level for onTrimMemory(int): the process is not an expendable background process, but the device is running extremely low on memory and is about to not be able to keep any background processes running. Your running process should free up as many non-critical resources as it can to allow that memory to be used elsewhere. The next thing that will happen after this is onLowMemory() called to report that nothing at all can be kept in the background, a situation that can start to notably impact the user. Int TRIM_MEMORY_RUNNING_LOW Level for onTrimMemory(int): the process is not an expendable background process, but the device is running low on memory. Your running process should free up unneeded resources to allow that memory to be used elsewhere. Int TRIM_MEMORY_RUNNING_MODERATE Level for onTrimMemory(int): the process is not an expendable background process, but the device is running moderately low on memory. Your running process may want to release some unneeded resources for use elsewhere. Int TRIM_MEMORY_UI_HIDDEN Level for onTrimMemory(int): the process had been showing a user interface, and is no longer doing so. Large allocations with the UI should be released at this point to allow memory to be better managed.

Public constructors
CloudMediaProvider()

Public methods
Unit	attachInfo(context: Context, info: ProviderInfo) Implementation is provided by the parent class.
Bundle	call(method: String, arg: String?, extras: Bundle?) Implementation is provided by the parent class.
Uri	canonicalize(uri: Uri) Implementation is provided by the parent class.
Int	delete(uri: Uri, selection: String?, selectionArgs: Array<String!>?) Implementation is provided by the parent class.
String	getType(uri: Uri) Implementation is provided by the parent class.
Uri	insert(uri: Uri, values: ContentValues!) Implementation is provided by the parent class.
open CloudMediaProvider.CloudMediaSurfaceController?	onCreateCloudMediaSurfaceController(config: Bundle, callback: CloudMediaProvider.CloudMediaSurfaceStateChangedCallback) Returns a CloudMediaSurfaceController used for rendering the preview of media items, or null if preview rendering is not supported.
open CloudMediaProviderContract.Capabilities	onGetCapabilities() Returns the CloudMediaProviderContract.Capabilities of this CloudMediaProvider.
abstract Bundle	onGetMediaCollectionInfo(extras: Bundle) Returns metadata about the media collection itself.
abstract ParcelFileDescriptor	onOpenMedia(mediaId: String, extras: Bundle?, signal: CancellationSignal?) Returns the full size media item identified by mediaId.
abstract AssetFileDescriptor	onOpenPreview(mediaId: String, size: Point, extras: Bundle?, signal: CancellationSignal?) Returns a thumbnail of size for a media item identified by mediaId
open Cursor	onQueryAlbums(extras: Bundle) Returns a cursor representing all album items in the media collection optionally filtered by extras and sorted in reverse chronological order of CloudMediaProviderContract.AlbumColumns.DATE_TAKEN_MILLIS, i.
abstract Cursor	onQueryDeletedMedia(extras: Bundle) Returns a Cursor representing all deleted media items in the entire media collection within the current provider version as returned by onGetMediaCollectionInfo.
abstract Cursor	onQueryMedia(extras: Bundle) Returns a cursor representing all media items in the media collection optionally filtered by extras and sorted in reverse chronological order of CloudMediaProviderContract.MediaColumns.DATE_TAKEN_MILLIS, i.
open Cursor	onQueryMediaCategories(parentCategoryId: String?, extras: Bundle, cancellationSignal: CancellationSignal?) Queries for the available MediaCategories under the given parentCategoryId, filtered by extras.
open Cursor	onQueryMediaInMediaSet(mediaSetId: String, extras: Bundle, cancellationSignal: CancellationSignal?) Queries for the available media items under a given mediaSetId, filtered by extras.
open Cursor	onQueryMediaSets(mediaCategoryId: String, extras: Bundle, cancellationSignal: CancellationSignal?) Queries for the available MediaSets under a given mediaCategoryId, filtered by extras.
open Cursor	onQuerySearchSuggestions(prefixText: String, extras: Bundle, cancellationSignal: CancellationSignal?) Queries for the available SearchSuggestions based on a prefixText, filtered by extras.
open Cursor	onSearchMedia(searchText: String, extras: Bundle, cancellationSignal: CancellationSignal?) Searches media items based on entered search text, managed by extras and returns a cursor of CloudMediaProviderContract.MediaColumns based on the match.
open Cursor	onSearchMedia(suggestedMediaSetId: String, fallbackSearchText: String?, extras: Bundle, cancellationSignal: CancellationSignal?) Searches media items based on a selected suggestion, managed by extras and returns a cursor of CloudMediaProviderContract.MediaColumns based on the match.
ParcelFileDescriptor	openFile(uri: Uri, mode: String) Implementation is provided by the parent class.
ParcelFileDescriptor	openFile(uri: Uri, mode: String, signal: CancellationSignal?) Implementation is provided by the parent class.
AssetFileDescriptor	openTypedAssetFile(uri: Uri, mimeTypeFilter: String, opts: Bundle?) Implementation is provided by the parent class.
AssetFileDescriptor	openTypedAssetFile(uri: Uri, mimeTypeFilter: String, opts: Bundle?, signal: CancellationSignal?) Implementation is provided by the parent class.
Cursor	query(uri: Uri, projection: Array<String!>?, queryArgs: Bundle?, cancellationSignal: CancellationSignal?) Implementation is provided by the parent class.
Cursor	query(uri: Uri, projection: Array<String!>?, selection: String?, selectionArgs: Array<String!>?, sortOrder: String?) Implementation is provided by the parent class.
Cursor	query(uri: Uri, projection: Array<String!>?, selection: String?, selectionArgs: Array<String!>?, sortOrder: String?, cancellationSignal: CancellationSignal?) Implementation is provided by the parent class.
Int	update(uri: Uri, values: ContentValues!, selection: String?, selectionArgs: Array<String!>?) Implementation is provided by the parent class.

Inherited functions
From class ContentProvider Array<ContentProviderResult!> applyBatch(authority: String, operations: ArrayList<ContentProviderOperation!>) Override this to handle requests to perform a batch of operations, or the default implementation will iterate over the operations and call ContentProviderOperation.apply on each of them. If all calls to ContentProviderOperation.apply succeed then a ContentProviderResult array with as many elements as there were operations will be returned. If any of the calls fail, it is up to the implementation how many of the others take effect. This method can be called from multiple threads, as described in Processes and Threads. Array<ContentProviderResult!> applyBatch(operations: ArrayList<ContentProviderOperation!>) Int bulkInsert(uri: Uri, values: Array<ContentValues!>) Override this to handle requests to insert a set of new rows, or the default implementation will iterate over the values and call #insert on each of them. As a courtesy, call notifyChange() after inserting. This method can be called from multiple threads, as described in Processes and Threads. Bundle? call(authority: String, method: String, arg: String?, extras: Bundle?) Call a provider-defined method. This can be used to implement interfaces that are cheaper and/or unnatural for a table-like model. WARNING: The framework does no permission checking on this entry into the content provider besides the basic ability for the application to get access to the provider at all. For example, it has no idea whether the call being executed may read or write data in the provider, so can't enforce those individual permissions. Any implementation of this method must do its own permission checks on incoming calls to make sure they are allowed. ContentProvider.CallingIdentity clearCallingIdentity() Reset the identity of the incoming IPC on the current thread. Internally this calls Binder.clearCallingIdentity() and also clears any value stored in getCallingPackage(). Int delete(uri: Uri, extras: Bundle?) Implement this to handle requests to delete one or more rows. The implementation should apply the selection clause when performing deletion, allowing the operation to affect multiple rows in a directory. As a courtesy, call notifyChange() after deleting. This method can be called from multiple threads, as described in Processes and Threads. The implementation is responsible for parsing out a row ID at the end of the URI, if a specific row is being deleted. That is, the client would pass in content://contacts/people/22 and the implementation is responsible for parsing the record number (22) when creating a SQL statement. Unit dump(fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!) Print the Provider's state into the given stream. This gets invoked if you run "adb shell dumpsys activity provider <provider_component_name>". AttributionSource? getCallingAttributionSource() Gets the attribution source of the calling app. If you want to attribute the data access to the calling app you can create an attribution context via android.content.Context#createContext(ContextParams) and passing this identity to ContextParams.Builder.setNextAttributionSource(. String? getCallingAttributionTag() Return the attribution tag of the caller that initiated the request being processed on the current thread. Returns null if not currently processing a request of the request is for the default attribution. This will always return null when processing getTypeAnonymous(android.net.Uri) requests For getType(android.net.Uri) requests, this will be only available for cases, where the caller can be identified. See getTypeAnonymous(android.net.Uri) String? getCallingPackage() Return the package name of the caller that initiated the request being processed on the current thread. The returned package will have been verified to belong to the calling UID. Returns null if not currently processing a request. This will always return null when processing getTypeAnonymous(android.net.Uri) requests For getType(android.net.Uri) requests, this will be only available for cases, where the caller can be identified. See getTypeAnonymous(android.net.Uri) String? getCallingPackageUnchecked() Return the package name of the caller that initiated the request being processed on the current thread. The returned package will have not been verified to belong to the calling UID. Returns null if not currently processing a request. This will always return null when processing getTypeAnonymous(android.net.Uri) requests For getType(android.net.Uri) requests, this will be only available for cases, where the caller can be identified. See getTypeAnonymous(android.net.Uri) Context? getContext() Retrieves the Context this provider is running in. Only available once onCreate has been called -- this will return null in the constructor. Array<PathPermission!>? getPathPermissions() Return the path-based permissions required for read and/or write access to this content provider. This method can be called from multiple threads, as described in Processes and Threads. String? getReadPermission() Return the name of the permission required for read-only access to this content provider. This method can be called from multiple threads, as described in Processes and Threads. Array<String!>? getStreamTypes(uri: Uri, mimeTypeFilter: String) Called by a client to determine the types of data streams that this content provider supports for the given URI. The default implementation returns null, meaning no types. If your content provider stores data of a particular type, return that MIME type if it matches the given mimeTypeFilter. If it can perform type conversions, return an array of all supported MIME types that match mimeTypeFilter. String? getTypeAnonymous(uri: Uri) Implement this to handle requests for MIME type of URIs, that does not need to reveal any internal information which should be protected by any permission. If your mime type reveals details that should be protected, then you should protect those by implementing those in getType, and in this function, only return types of URIs which can be obtained by anyone without any access. Implementing ths function will make sure getType is protected by readPermission. This function by default works as the getType String? getWritePermission() Return the name of the permission required for read/write access to this content provider. This method can be called from multiple threads, as described in Processes and Threads. Uri? insert(uri: Uri, values: ContentValues?, extras: Bundle?) Implement this to handle requests to insert a new row. As a courtesy, call notifyChange() after inserting. This method can be called from multiple threads, as described in Processes and Threads. Boolean isTemporary() Returns true if this instance is a temporary content provider. Unit onCallingPackageChanged() Called whenever the value of getCallingPackage() changes, giving the provider an opportunity to invalidate any security related caching it may be performing. This typically happens when a ContentProvider makes a nested call back into itself when already processing a call from a remote process. Unit onConfigurationChanged(newConfig: Configuration) Called by the system when the device configuration changes while your component is running. Note that, unlike activities, other components are never restarted when a configuration changes: they must always deal with the results of the change, such as by re-retrieving resources. At the time that this function has been called, your Resources object will have been updated to return resource values matching the new configuration. For more information, read Handling Runtime Changes. This method is always called on the application main thread, and must not perform lengthy operations. The default content provider implementation does nothing. Override this method to take appropriate action. (Content providers do not usually care about things like screen orientation, but may want to know about locale changes.) Boolean onCreate() Implement this to initialize your content provider on startup. This method is called for all registered content providers on the application main thread at application launch time. It must not perform lengthy operations, or application startup will be delayed. You should defer nontrivial initialization (such as opening, upgrading, and scanning databases) until the content provider is used (via #query, #insert, etc). Deferred initialization keeps application startup fast, avoids unnecessary work if the provider turns out not to be needed, and stops database errors (such as a full disk) from halting application launch. If you use SQLite, android.database.sqlite.SQLiteOpenHelper is a helpful utility class that makes it easy to manage databases, and will automatically defer opening until first use. If you do use SQLiteOpenHelper, make sure to avoid calling android.database.sqlite.SQLiteOpenHelper#getReadableDatabase or android.database.sqlite.SQLiteOpenHelper#getWritableDatabase from this method. (Instead, override android.database.sqlite.SQLiteOpenHelper#onOpen to initialize the database when it is first opened.) Unit onLowMemory() This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. While the exact point at which this will be called is not defined, generally it will happen when all background process have been killed. That is, before reaching the point of killing processes hosting service and foreground UI that we would like to avoid killing. This method is always called on the application main thread, and must not perform lengthy operations. The default content provider implementation does nothing. Subclasses may override this method to take appropriate action. Unit onTrimMemory(level: Int) AssetFileDescriptor? openAssetFile(uri: Uri, mode: String) This is like #openFile, but can be implemented by providers that need to be able to return sub-sections of files, often assets inside of their .apk. This method can be called from multiple threads, as described in Processes and Threads. If you implement this, your clients must be able to deal with such file slices, either directly with android.content.ContentResolver#openAssetFileDescriptor, or by using the higher-level ContentResolver.openInputStream or android.content.ContentResolver#openOutputStream methods. The returned AssetFileDescriptor can be a pipe or socket pair to enable streaming of data. If you are implementing this to return a full file, you should create the AssetFileDescriptor with AssetFileDescriptor.UNKNOWN_LENGTH to be compatible with applications that cannot handle sub-sections of files. For use in Intents, you will want to implement getType to return the appropriate MIME type for the data returned here with the same URI. This will allow intent resolution to automatically determine the data MIME type and select the appropriate matching targets as part of its operation. For better interoperability with other applications, it is recommended that for any URIs that can be opened, you also support queries on them containing at least the columns specified by android.provider.OpenableColumns. AssetFileDescriptor? openAssetFile(uri: Uri, mode: String, signal: CancellationSignal?) This is like #openFile, but can be implemented by providers that need to be able to return sub-sections of files, often assets inside of their .apk. This method can be called from multiple threads, as described in Processes and Threads. If you implement this, your clients must be able to deal with such file slices, either directly with android.content.ContentResolver#openAssetFileDescriptor, or by using the higher-level ContentResolver.openInputStream or android.content.ContentResolver#openOutputStream methods. The returned AssetFileDescriptor can be a pipe or socket pair to enable streaming of data. If you are implementing this to return a full file, you should create the AssetFileDescriptor with AssetFileDescriptor.UNKNOWN_LENGTH to be compatible with applications that cannot handle sub-sections of files. For use in Intents, you will want to implement getType to return the appropriate MIME type for the data returned here with the same URI. This will allow intent resolution to automatically determine the data MIME type and select the appropriate matching targets as part of its operation. For better interoperability with other applications, it is recommended that for any URIs that can be opened, you also support queries on them containing at least the columns specified by android.provider.OpenableColumns. ParcelFileDescriptor openFileHelper(uri: Uri, mode: String) Convenience for subclasses that wish to implement #openFile by looking up a column named "_data" at the given URI. ParcelFileDescriptor openPipeHelper(uri: Uri, mimeType: String, opts: Bundle?, args: T?, func: ContentProvider.PipeDataWriter<T>) A helper function for implementing #openTypedAssetFile, for creating a data pipe and background thread allowing you to stream generated data back to the client. This function returns a new ParcelFileDescriptor that should be returned to the caller (the caller is responsible for closing it). Boolean refresh(uri: Uri!, extras: Bundle?, cancellationSignal: CancellationSignal?) Implement this to support refresh of content identified by uri. By default, this method returns false; providers who wish to implement this should return true to signal the client that the provider has tried refreshing with its own implementation. 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. Remember to send ContentResolver.notifyChange(Uri, android.database.ContentObserver) notifications when content changes. Context requireContext() Retrieves a Non-Nullable Context this provider is running in, this is intended to be called after onCreate. When called before context was created, an IllegalStateException will be thrown. Note A provider must be declared in the manifest and created automatically by the system, and context is only available after onCreate is called. Unit restoreCallingIdentity(identity: ContentProvider.CallingIdentity) Restore the identity of the incoming IPC on the current thread back to a previously identity that was returned by clearCallingIdentity. Internally this calls Binder.restoreCallingIdentity(long) and also restores any value stored in getCallingPackage(). Unit setPathPermissions(permissions: Array<PathPermission!>?) Change the path-based permission required to read and/or write data in the content provider. This is normally set for you from its manifest information when the provider is first created. Unit setReadPermission(permission: String?) Change the permission required to read data from the content provider. This is normally set for you from its manifest information when the provider is first created. Unit setWritePermission(permission: String?) Change the permission required to read and write data in the content provider. This is normally set for you from its manifest information when the provider is first created. Unit shutdown() Implement this to shut down the ContentProvider instance. You can then invoke this method in unit tests. Android normally handles ContentProvider startup and shutdown automatically. You do not need to start up or shut down a ContentProvider. When you invoke a test method on a ContentProvider, however, a ContentProvider instance is started and keeps running after the test finishes, even if a succeeding test instantiates another ContentProvider. A conflict develops because the two instances are usually running against the same underlying data source (for example, an sqlite database). Implementing shutDown() avoids this conflict by providing a way to terminate the ContentProvider. This method can also prevent memory leaks from multiple instantiations of the ContentProvider, and it can ensure unit test isolation by allowing you to completely clean up the test fixture before moving on to the next test. Uri? uncanonicalize(url: Uri) Remove canonicalization from canonical URIs previously returned by canonicalize. For example, if your implementation is to add a query param to canonicalize a URI, this method can simply trip any query params on the URI. The default implementation always returns the same url that was passed in. Int update(uri: Uri, values: ContentValues?, extras: Bundle?) Implement this to handle requests to update one or more rows. The implementation should update all rows matching the selection to set the columns according to the provided values map. As a courtesy, call notifyChange() after updating. This method can be called from multiple threads, as described in Processes and Threads.
From class ComponentCallbacks Unit onConfigurationChanged(newConfig: Configuration) Called by the system when the device configuration changes while your component is running. Note that, unlike activities, other components are never restarted when a configuration changes: they must always deal with the results of the change, such as by re-retrieving resources. At the time that this function has been called, your Resources object will have been updated to return resource values matching the new configuration. For more information, read Handling Runtime Changes. Unit onLowMemory() This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. While the exact point at which this will be called is not defined, generally it will happen when all background process have been killed. That is, before reaching the point of killing processes hosting service and foreground UI that we would like to avoid killing.

Public constructors

CloudMediaProvider

Added in API level 33
Also in R Extensions 3

CloudMediaProvider()

Public methods

attachInfo

Added in API level 33

fun attachInfo(
    context: Context, 
    info: ProviderInfo
): Unit

Implementation is provided by the parent class. Cannot be overridden.

Parameters
context	Context: This value cannot be null.
info	ProviderInfo: This value cannot be null.

call

Added in API level 33

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

Implementation is provided by the parent class. Cannot be overridden.

Parameters
method	String: This value cannot be null.
arg	String?: This value may be null.
extras	Bundle?: This value may be null.

Return
Bundle	This value cannot be null.

canonicalize

Added in API level 33

fun canonicalize(uri: Uri): Uri

Implementation is provided by the parent class. Throws by default, and cannot be overridden.

Parameters
url	The Uri to canonicalize. This value cannot be null.
uri	Uri: This value cannot be null.

Return
Uri	This value cannot be null.

delete

Added in API level 33

fun delete(
    uri: Uri, 
    selection: String?, 
    selectionArgs: Array<String!>?
): Int

Implementation is provided by the parent class. Throws by default, and cannot be overridden.

Parameters
uri	Uri: This value cannot be null.
selection	String?: This value may be null.
selectionArgs	Array<String!>?: This value may be null.

Return
Int	The number of rows affected.

Exceptions
android.database.SQLException

getType

Added in API level 33

fun getType(uri: Uri): String

Implementation is provided by the parent class. Throws by default, and cannot be overridden.

Parameters
uri	Uri: This value cannot be null.

Return
String	This value cannot be null.

insert

Added in API level 33

fun insert(
    uri: Uri, 
    values: ContentValues!
): Uri

Implementation is provided by the parent class. Throws by default, and cannot be overridden.

Parameters
uri	Uri: This value cannot be null.
values	ContentValues!: This value cannot be null.

Return
Uri	This value cannot be null.

onCreateCloudMediaSurfaceController

Added in API level 33
Also in R Extensions 3

open fun onCreateCloudMediaSurfaceController(
    config: Bundle, 
    callback: CloudMediaProvider.CloudMediaSurfaceStateChangedCallback
): CloudMediaProvider.CloudMediaSurfaceController?

Returns a CloudMediaSurfaceController used for rendering the preview of media items, or null if preview rendering is not supported.

Parameters
config	Bundle: containing configuration parameters for CloudMediaSurfaceController CloudMediaProviderContract.EXTRA_LOOPING_PLAYBACK_ENABLED CloudMediaProviderContract.EXTRA_SURFACE_CONTROLLER_AUDIO_MUTE_ENABLED This value cannot be null.
callback	CloudMediaProvider.CloudMediaSurfaceStateChangedCallback: CloudMediaSurfaceStateChangedCallback to send state updates for Surface to picker launched via MediaStore.ACTION_PICK_IMAGES This value cannot be null.

onGetCapabilities

Added in API level Baklava

open fun onGetCapabilities(): CloudMediaProviderContract.Capabilities

Returns the CloudMediaProviderContract.Capabilities of this CloudMediaProvider. This object is used to determine which APIs can be safely invoked during runtime. If not overridden the default capabilities are used. IMPORTANT: This method is performance critical and should avoid long running or expensive operations.

Return
CloudMediaProviderContract.Capabilities	This value cannot be null.

See Also

• android.provider.CloudMediaProviderContract.Capabilities

onGetMediaCollectionInfo

Added in API level 33
Also in R Extensions 3

abstract fun onGetMediaCollectionInfo(extras: Bundle): Bundle

Returns metadata about the media collection itself.

This is useful for the OS to determine if its cache of media items in the collection is still valid and if a full or incremental sync is required with onQueryMedia.

This method might be called by the OS frequently and is performance critical, hence it should avoid long running operations.

If the provider handled any filters in extras, it must add the key to the ContentResolver.EXTRA_HONORED_ARGS as part of the returned Bundle.

Parameters
extras	Bundle: containing keys to filter result: CloudMediaProviderContract.EXTRA_ALBUM_ID This value cannot be null.

Return
Bundle	Bundle containing CloudMediaProviderContract.MediaCollectionInfo CloudMediaProviderContract.MediaCollectionInfo.MEDIA_COLLECTION_ID CloudMediaProviderContract.MediaCollectionInfo.LAST_MEDIA_SYNC_GENERATION CloudMediaProviderContract.MediaCollectionInfo.ACCOUNT_NAME CloudMediaProviderContract.MediaCollectionInfo.ACCOUNT_CONFIGURATION_INTENT This value cannot be null.

onOpenMedia

Added in API level 33
Also in R Extensions 3

abstract fun onOpenMedia(
    mediaId: String, 
    extras: Bundle?, 
    signal: CancellationSignal?
): ParcelFileDescriptor

Returns the full size media item identified by mediaId.

If you block while downloading content, you should periodically check CancellationSignal.isCanceled() to abort abandoned open requests.

Parameters
mediaId	String: the media item to return This value cannot be null.
extras	Bundle?: to modify the way the fd is opened, there's none at the moment, but some might be implemented in the future This value may be null.
signal	CancellationSignal?: used by the OS to signal if the request should be cancelled This value may be null.

Return
ParcelFileDescriptor	read-only file descriptor for accessing the media file This value cannot be null.

See Also

• #onOpenPreview

onOpenPreview

Added in API level 33
Also in R Extensions 3

abstract fun onOpenPreview(
    mediaId: String, 
    size: Point, 
    extras: Bundle?, 
    signal: CancellationSignal?
): AssetFileDescriptor

Returns a thumbnail of size for a media item identified by mediaId

The cloud media provider should strictly return thumbnail in the original CloudMediaProviderContract.MediaColumns.MIME_TYPE of the item.

This is expected to be a much lower resolution version than the item returned by onOpenMedia.

If you block while downloading content, you should periodically check CancellationSignal.isCanceled() to abort abandoned open requests.

Parameters
mediaId	String: the media item to return This value cannot be null.
size	Point: the dimensions of the thumbnail to return. The returned file descriptor doesn't have to match the size precisely because the OS will adjust the dimensions before usage. Implementations can return close approximations especially if the approximation is already locally on the device and doesn't require downloading from the cloud. This value cannot be null.
extras	Bundle?: to modify the way the fd is opened, e.g. for video files we may request a thumbnail image instead of a video with CloudMediaProviderContract.EXTRA_PREVIEW_THUMBNAIL This value may be null.
signal	CancellationSignal?: used by the OS to signal if the request should be cancelled This value may be null.

Return
AssetFileDescriptor	read-only file descriptor for accessing the thumbnail for the media file This value cannot be null.

See Also

• #onOpenMedia
• android.provider.CloudMediaProviderContract#EXTRA_PREVIEW_THUMBNAIL

onQueryAlbums

Added in API level 33
Also in R Extensions 3

open fun onQueryAlbums(extras: Bundle): Cursor

Returns a cursor representing all album items in the media collection optionally filtered by extras and sorted in reverse chronological order of CloudMediaProviderContract.AlbumColumns.DATE_TAKEN_MILLIS, i.e. most recent items first.

The cloud media provider must set the CloudMediaProviderContract.EXTRA_MEDIA_COLLECTION_ID as part of the returned Cursor.setExtras Bundle. Not setting this is an error and invalidates the returned Cursor.

If the provider handled any filters in extras, it must add the key to the ContentResolver.EXTRA_HONORED_ARGS as part of the returned Cursor.setExtras Bundle.

Parameters
extras	Bundle: containing keys to filter album items: CloudMediaProviderContract.EXTRA_SYNC_GENERATION CloudMediaProviderContract.EXTRA_PAGE_TOKEN CloudMediaProviderContract.EXTRA_PAGE_SIZE android.content.Intent#EXTRA_MIME_TYPES This value cannot be null.

Return
Cursor	cursor representing album items containing all CloudMediaProviderContract.AlbumColumns columns This value cannot be null.

onQueryDeletedMedia

Added in API level 33
Also in R Extensions 3

abstract fun onQueryDeletedMedia(extras: Bundle): Cursor

Returns a Cursor representing all deleted media items in the entire media collection within the current provider version as returned by onGetMediaCollectionInfo. These items can be optionally filtered by extras.

The cloud media provider must set the CloudMediaProviderContract.EXTRA_MEDIA_COLLECTION_ID as part of the returned Cursor.setExtras Bundle. Not setting this is an error and invalidates the returned Cursor.

If the provider handled any filters in extras, it must add the key to the ContentResolver.EXTRA_HONORED_ARGS as part of the returned Cursor.setExtras Bundle.

Parameters
extras	Bundle: containing keys to filter deleted media items: CloudMediaProviderContract.EXTRA_SYNC_GENERATION CloudMediaProviderContract.EXTRA_PAGE_TOKEN This value cannot be null.

Return
Cursor	cursor representing deleted media items containing just the CloudMediaProviderContract.MediaColumns.ID column This value cannot be null.

onQueryMedia

Added in API level 33
Also in R Extensions 3

abstract fun onQueryMedia(extras: Bundle): Cursor

Returns a cursor representing all media items in the media collection optionally filtered by extras and sorted in reverse chronological order of CloudMediaProviderContract.MediaColumns.DATE_TAKEN_MILLIS, i.e. most recent items first.

The cloud media provider must set the CloudMediaProviderContract.EXTRA_MEDIA_COLLECTION_ID as part of the returned Cursor.setExtras Bundle. Not setting this is an error and invalidates the returned Cursor.

If the cloud media provider handled any filters in extras, it must add the key to the ContentResolver.EXTRA_HONORED_ARGS as part of the returned Cursor.setExtras Bundle.

Parameters
extras	Bundle: containing keys to filter media items: CloudMediaProviderContract.EXTRA_SYNC_GENERATION CloudMediaProviderContract.EXTRA_PAGE_TOKEN CloudMediaProviderContract.EXTRA_ALBUM_ID CloudMediaProviderContract.EXTRA_PAGE_SIZE This value cannot be null.

Return
Cursor	cursor representing media items containing all CloudMediaProviderContract.MediaColumns columns This value cannot be null.

onQueryMediaCategories

Added in API level Baklava

open fun onQueryMediaCategories(
    parentCategoryId: String?, 
    extras: Bundle, 
    cancellationSignal: CancellationSignal?
): Cursor

Queries for the available MediaCategories under the given parentCategoryId, filtered by extras. The columns of MediaCategories are in the class CloudMediaProviderContract.MediaCategoryColumns.

When parentCategoryId is null, this returns the root categories.

The order in which media categories are sorted in the cursor will be retained when displaying results to the user.

The cloud media provider must set the CloudMediaProviderContract.EXTRA_MEDIA_COLLECTION_ID as part of the returned cursor by using Cursor.setExtras. Not setting this is an error and invalidates the returned Cursor, meaning photo picker will not use the cursor for any operation.

extras may contain some key-value pairs which should be used to filter the results. If the provider handled any filters in extras, it must add the key to the ContentResolver.EXTRA_HONORED_ARGS as part of the returned cursor by using Cursor.setExtras. If not honored, photo picker will assume the result of the query is without the extra being used. Note: Currently this function does not pass any params in extras.

Parameters
parentCategoryId	String?: the ID of the parent category to filter media categories. This value may be null.
extras	Bundle: containing keys to filter media categories: android.content.Intent#EXTRA_MIME_TYPES This value cannot be null.
cancellationSignal	CancellationSignal?: CancellationSignal to check if request has been cancelled. This value may be null.

Return
Cursor	cursor with CloudMediaProviderContract.MediaCategoryColumns columns

onQueryMediaInMediaSet

Added in API level Baklava

open fun onQueryMediaInMediaSet(
    mediaSetId: String, 
    extras: Bundle, 
    cancellationSignal: CancellationSignal?
): Cursor

Queries for the available media items under a given mediaSetId, filtered by extras. The columns of Media are in the class CloudMediaProviderContract.MediaColumns. mediaSetId is the ID given as part of CloudMediaProviderContract.MediaSetColumns.ID

The order in which media items are sorted in the cursor will be retained when displaying results to the user.

The cloud media provider must set the CloudMediaProviderContract.EXTRA_MEDIA_COLLECTION_ID as part of the returned Cursor by using Cursor.setExtras. Not setting this is an error and invalidates the returned Cursor, meaning photo picker will not use the cursor for any operation.

extras may contain some key-value pairs which should be used to prepare the results. If the provider handled any filters in extras, it must add the key to the ContentResolver.EXTRA_HONORED_ARGS as part of the returned cursor by using Cursor.setExtras. If not honored, photo picker will assume the result of the query is without the extra being used.

If the cloud media provider supports pagination, they can set CloudMediaProviderContract.EXTRA_PAGE_TOKEN as the next page token, as part of the returned cursor by using Cursor.setExtras. If a token is set, the OS will pass it as a key-value pair in extras when querying for media for subsequent pages. The provider can keep returning pagination tokens in the returned cursor by using Cursor.setExtras until the last page at which point it should not set a token in the returned cursor.

Parameters
mediaSetId	String: the ID of the media set to filter media items. This value cannot be null.
extras	Bundle: containing keys to filter media items: CloudMediaProviderContract.EXTRA_PAGE_TOKEN CloudMediaProviderContract.EXTRA_PAGE_SIZE CloudMediaProviderContract.EXTRA_SORT_ORDER android.content.Intent#EXTRA_MIME_TYPES This value cannot be null.
cancellationSignal	CancellationSignal?: CancellationSignal to check if request has been cancelled. This value may be null.

Return
Cursor	cursor representing CloudMediaProviderContract.MediaColumns columns This value cannot be null.

onQueryMediaSets

Added in API level Baklava

open fun onQueryMediaSets(
    mediaCategoryId: String, 
    extras: Bundle, 
    cancellationSignal: CancellationSignal?
): Cursor

Queries for the available MediaSets under a given mediaCategoryId, filtered by extras. The columns of MediaSet are in the class CloudMediaProviderContract.MediaSetColumns.

This returns MediaSets directly inside the given MediaCategoryId. If the passed mediaCategoryId has some more nested mediaCategories, the mediaSets inside the nested mediaCategories must not be returned in this response.

The order in which media sets are sorted in the cursor will be retained when displaying results to the user.

The cloud media provider must set the CloudMediaProviderContract.EXTRA_MEDIA_COLLECTION_ID as part of the returned cursor by using Cursor.setExtras . Not setting this is an error and invalidates the returned Cursor, meaning photo picker will not use the cursor for any operation.

extras may contain some key-value pairs which should be used to prepare the results. If the provider handled any filters in extras, it must add the key to the ContentResolver.EXTRA_HONORED_ARGS as part of the returned cursor by using Cursor.setExtras. If not honored, photo picker will assume the result of the query is without the extra being used.

If the cloud media provider supports pagination, they can set CloudMediaProviderContract.EXTRA_PAGE_TOKEN as the next page token, as part of the returned cursor by using Cursor.setExtras. If a token is set, the OS will pass it as a key-value pair in extras when querying for query media sets for subsequent pages. The provider can keep returning pagination tokens in the returned cursor by using Cursor.setExtras until the last page at which point it should not set a token in the returned cursor.

Parameters
mediaCategoryId	String: the ID of the media category to filter media sets. This value cannot be null.
extras	Bundle: containing keys to filter media sets: CloudMediaProviderContract.EXTRA_PAGE_TOKEN CloudMediaProviderContract.EXTRA_PAGE_SIZE android.content.Intent#EXTRA_MIME_TYPES This value cannot be null.
cancellationSignal	CancellationSignal?: CancellationSignal to check if request has been cancelled. This value may be null.

Return
Cursor	cursor representing CloudMediaProviderContract.MediaSetColumns columns This value cannot be null.

onQuerySearchSuggestions

Added in API level Baklava

open fun onQuerySearchSuggestions(
    prefixText: String, 
    extras: Bundle, 
    cancellationSignal: CancellationSignal?
): Cursor

Queries for the available SearchSuggestions based on a prefixText, filtered by extras. The columns of SearchSuggestions are in the class CloudMediaProviderContract.SearchSuggestionColumns

If the user has not started typing, this is considered as zero state suggestion. In this case prefixText will be empty string.

The order in which suggestions are sorted in the cursor will be retained when displaying results to the user.

The cloud media provider must set the CloudMediaProviderContract.EXTRA_MEDIA_COLLECTION_ID as part of the returned cursor by using Cursor.setExtras . Not setting this is an error and invalidates the returned Cursor, meaning photo picker will not use the cursor for any operation.

extras may contain some key-value pairs which should be used to prepare the results. If the provider handled any params in extras, it must add the key to the ContentResolver.EXTRA_HONORED_ARGS as part of the returned cursor by using Cursor.setExtras. If not honored, photo picker will assume the result of the query is without the extra being used. Note: Currently this function does not pass any key-value params in extras.

Results may not be displayed if it takes longer than 300 milliseconds to get a response from the cloud media provider.

Parameters
prefixText	String: the prefix text to filter search suggestions. This value cannot be null.
extras	Bundle: containing keys to filter search suggestions. CloudMediaProviderContract.EXTRA_PAGE_SIZE This value cannot be null.
cancellationSignal	CancellationSignal?: CancellationSignal to check if request has been cancelled. This value may be null.

Return
Cursor	cursor representing search suggestions containing all {@see CloudMediaProviderContract.SearchSuggestionColumns} columns This value cannot be null.

onSearchMedia

Added in API level Baklava

open fun onSearchMedia(
    searchText: String, 
    extras: Bundle, 
    cancellationSignal: CancellationSignal?
): Cursor

Searches media items based on entered search text, managed by extras and returns a cursor of CloudMediaProviderContract.MediaColumns based on the match.

The cloud media provider must set the CloudMediaProviderContract.EXTRA_MEDIA_COLLECTION_ID as part of the returned cursor by using Cursor.setExtras . Not setting this is an error and invalidates the returned Cursor, meaning photo picker will not use the cursor for any operation.

extras may contain some key-value pairs which should be used to prepare the results. If the provider handled any params in extras, it must add the key to the ContentResolver.EXTRA_HONORED_ARGS as part of the returned cursor by using Cursor.setExtras. If not honored, photo picker will assume the result of the query is without the extra being used.

An example user journey:

1. User enters the search prompt.
2. Using onQuerySearchSuggestions, photo picker display suggestions as the user keeps typing.
3. User types completely and then enters search, Photo picker calls: onSearchMedia(searchText, extras)

If the cloud media provider supports pagination, they can set CloudMediaProviderContract.EXTRA_PAGE_TOKEN as the next page token, as part of the returned cursor by using Cursor.setExtras. If a token is set, the OS will pass it as a key value pair in extras when querying for search media for subsequent pages. The provider can keep returning pagination tokens in the returned cursor by using Cursor.setExtras until the last page at which point it should not set a token in the returned cursor.

Results may not be displayed if it takes longer than 3 seconds to get a paged response from the cloud media provider.

Parameters
searchText	String: search text to be used. This value cannot be null.
extras	Bundle: containing keys to manage the search results: CloudMediaProviderContract.EXTRA_PAGE_TOKEN CloudMediaProviderContract.EXTRA_PAGE_SIZE CloudMediaProviderContract.EXTRA_SORT_ORDER android.content.Intent#EXTRA_MIME_TYPES This value cannot be null.
cancellationSignal	CancellationSignal?: CancellationSignal to check if request has been cancelled. This value may be null.

Return
Cursor	cursor of CloudMediaProviderContract.MediaColumns based on the match. This value cannot be null.

onSearchMedia

Added in API level Baklava

open fun onSearchMedia(
    suggestedMediaSetId: String, 
    fallbackSearchText: String?, 
    extras: Bundle, 
    cancellationSignal: CancellationSignal?
): Cursor

Searches media items based on a selected suggestion, managed by extras and returns a cursor of CloudMediaProviderContract.MediaColumns based on the match.

The cloud media provider must set the CloudMediaProviderContract.EXTRA_MEDIA_COLLECTION_ID as part of the returned cursor by using Cursor.setExtras . Not setting this is an error and invalidates the returned Cursor, meaning photo picker will not use the cursor for any operation.

extras may contain some key-value pairs which should be used to prepare the results. If the provider handled any params in extras, it must add the key to the ContentResolver.EXTRA_HONORED_ARGS as part of the returned cursor by using Cursor.setExtras. If not honored, photo picker will assume the result of the query is without the extra being used.

An example user journey:

1. User enters the search prompt.
2. Using onQuerySearchSuggestions, photo picker display suggestions as the user keeps typing.
3. User selects a suggestion, Photo picker calls: onSearchMedia(suggestedMediaSetId, fallbackSearchText, extras) with the suggestedMediaSetId corresponding to the user chosen suggestion. CloudMediaProviderContract.SearchSuggestionColumns.MEDIA_SET_ID

If the cloud media provider supports pagination, they can set CloudMediaProviderContract.EXTRA_PAGE_TOKEN as the next page token, as part of the returned cursor by using Cursor.setExtras. If a token is set, the OS will pass it as a key value pair in extras when querying for search media for subsequent pages. The provider can keep returning pagination tokens in the returned cursor by using Cursor.setExtras until the last page at which point it should not set a token in the returned cursor

Results may not be displayed if it takes longer than 3 seconds to get a paged response from the cloud media provider.

Parameters
suggestedMediaSetId	String: the media set ID of the suggestion that the user wants to search. This value cannot be null.
fallbackSearchText	String?: optional search text to be used when suggestedMediaSetId is not useful. This value may be null.
extras	Bundle: containing keys to manage the search results: CloudMediaProviderContract.EXTRA_PAGE_TOKEN CloudMediaProviderContract.EXTRA_PAGE_SIZE CloudMediaProviderContract.EXTRA_SORT_ORDER android.content.Intent#EXTRA_MIME_TYPES This value cannot be null.
cancellationSignal	CancellationSignal?: CancellationSignal to check if request has been cancelled. This value may be null.

Return
Cursor	cursor of CloudMediaProviderContract.MediaColumns based on the match. This value cannot be null.

See Also

• android.provider.CloudMediaProviderContract.SearchSuggestionColumns#MEDIA_SET_ID

openFile

Added in API level 33

fun openFile(
    uri: Uri, 
    mode: String
): ParcelFileDescriptor

Implementation is provided by the parent class. Cannot be overridden.

Parameters
uri	Uri: This value cannot be null.
mode	String: This value cannot be null.

Return
ParcelFileDescriptor	This value cannot be null.

Exceptions
java.io.FileNotFoundException	Throws FileNotFoundException if there is no file associated with the given URI or the mode is invalid.
java.lang.SecurityException	Throws SecurityException if the caller does not have permission to access the file.

See Also

• #onOpenMedia

openFile

Added in API level 33

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

Implementation is provided by the parent class. Cannot be overridden.

Parameters
uri	Uri: This value cannot be null.
mode	String: This value cannot be null.
signal	CancellationSignal?: This value may be null.

Return
ParcelFileDescriptor	This value cannot be null.

Exceptions
java.io.FileNotFoundException	Throws FileNotFoundException if there is no file associated with the given URI or the mode is invalid.
java.lang.SecurityException	Throws SecurityException if the caller does not have permission to access the file.

See Also

• #onOpenMedia

openTypedAssetFile

Added in API level 33

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

Implementation is provided by the parent class. Cannot be overridden.

Parameters
uri	Uri: This value cannot be null.
mimeTypeFilter	String: This value cannot be null.
opts	Bundle?: This value may be null.

Return
AssetFileDescriptor	This value cannot be null.

Exceptions
java.io.FileNotFoundException	Throws FileNotFoundException if there is no file associated with the given URI or the mode is invalid.
java.lang.SecurityException	Throws SecurityException if the caller does not have permission to access the data.
java.lang.IllegalArgumentException	Throws IllegalArgumentException if the content provider does not support the requested MIME type.

See Also

• #onOpenPreview
• #onOpenMedia

openTypedAssetFile

Added in API level 33

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

Implementation is provided by the parent class. Cannot be overridden.

Parameters
uri	Uri: This value cannot be null.
mimeTypeFilter	String: This value cannot be null.
opts	Bundle?: This value may be null.
signal	CancellationSignal?: This value may be null.

Return
AssetFileDescriptor	This value cannot be null.

Exceptions
java.io.FileNotFoundException	Throws FileNotFoundException if there is no file associated with the given URI or the mode is invalid.
java.lang.SecurityException	Throws SecurityException if the caller does not have permission to access the data.
java.lang.IllegalArgumentException	Throws IllegalArgumentException if the content provider does not support the requested MIME type.

See Also

• #onOpenPreview
• #onOpenMedia

query

Added in API level 33

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

Implementation is provided by the parent class. Cannot be overridden.

Parameters
uri	Uri: This value cannot be null.
projection	Array<String!>?: This value may be null.
queryArgs	Bundle?: This value may be null.
cancellationSignal	CancellationSignal?: This value may be null.

Return
Cursor	This value cannot be null.

See Also

• #onQueryMedia
• #onQueryDeletedMedia
• #onQueryAlbums

query

Added in API level 33

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

Implementation is provided by the parent class. Throws by default, and cannot be overridden.

Parameters
uri	Uri: This value cannot be null.
projection	Array<String!>?: This value may be null.
selection	String?: This value may be null.
selectionArgs	Array<String!>?: This value may be null.
sortOrder	String?: This value may be null.

Return
Cursor	This value cannot be null.

query

Added in API level 33

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

Implementation is provided by the parent class. Throws by default, and cannot be overridden.

Parameters
uri	Uri: This value cannot be null.
projection	Array<String!>?: This value may be null.
selection	String?: This value may be null.
selectionArgs	Array<String!>?: This value may be null.
sortOrder	String?: This value may be null.
cancellationSignal	CancellationSignal?: This value may be null.

Return
Cursor	This value cannot be null.

update

Added in API level 33

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

Implementation is provided by the parent class. Throws by default, and cannot be overridden.

Parameters
uri	Uri: This value cannot be null.
values	ContentValues!: This value cannot be null.
selection	String?: This value may be null.
selectionArgs	Array<String!>?: This value may be null.

Return
Int	the number of rows affected.