Most visited

Recently visited

Results for

Added in API level 19

Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

DocumentsProvider

public abstract class DocumentsProvider
extends ContentProvider

java.lang.Object
↳	android.content.ContentProvider
	↳	android.provider.DocumentsProvider

Base class for a document provider. A document provider offers read and write access to durable files, such as files stored on a local disk, or files in a cloud storage service. To create a document 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:grantUriPermissions="true"
            android:permission="android.permission.MANAGE_DOCUMENTS"
            android:enabled="@bool/isAtLeastKitKat">
            <intent-filter>
                <action android:name="android.content.action.DOCUMENTS_PROVIDER" />
            </intent-filter>
        </provider>
        ...
    </application>
</manifest>

When defining your provider, you must protect it with MANAGE_DOCUMENTS, which is a permission only the system can obtain. Applications cannot use a documents provider directly; they must go through ACTION_OPEN_DOCUMENT or ACTION_CREATE_DOCUMENT which requires a user to actively navigate and select documents. When a user selects documents through that UI, the system issues narrow URI permission grants to the requesting application.

Documents

A document can be either an openable stream (with a specific MIME type), or a directory containing additional documents (with the MIME_TYPE_DIR MIME type). Each directory represents the top of a subtree containing zero or more documents, which can recursively contain even more documents and directories.

Each document can have different capabilities, as described by COLUMN_FLAGS. For example, if a document can be represented as a thumbnail, your provider can set FLAG_SUPPORTS_THUMBNAIL and implement openDocumentThumbnail(String, Point, CancellationSignal) to return that thumbnail.

Each document under a provider is uniquely referenced by its COLUMN_DOCUMENT_ID, which must not change once returned. A single document can be included in multiple directories when responding to queryChildDocuments(String, String[], String). For example, a provider might surface a single photo in multiple locations: once in a directory of geographic locations, and again in a directory of dates.

Roots

All documents are surfaced through one or more "roots." Each root represents the top of a document tree that a user can navigate. For example, a root could represent an account or a physical storage device. Similar to documents, each root can have capabilities expressed through COLUMN_FLAGS.

See also:

Summary

Inherited constants

From interface


    android.content.ComponentCallbacks2

Public constructors
`DocumentsProvider()`

Public methods
`void`	`attachInfo(Context context, ProviderInfo info)` Implementation is provided by the parent class.
`Bundle`	`call(String method, String arg, Bundle extras)` Implementation is provided by the parent class.
`Uri`	`canonicalize(Uri uri)` Implementation is provided by the parent class.
`String`	`copyDocument(String sourceDocumentId, String targetParentDocumentId)` Copy the requested document or a document tree.
`String`	`createDocument(String parentDocumentId, String mimeType, String displayName)` Create a new document and return its newly generated `COLUMN_DOCUMENT_ID`.
`final int`	`delete(Uri uri, String selection, String[] selectionArgs)` Implementation is provided by the parent class.
`void`	`deleteDocument(String documentId)` Delete the requested document.
`String[]`	`getDocumentStreamTypes(String documentId, String mimeTypeFilter)` Return a list of streamable MIME types matching the filter, which can be passed to `openTypedDocument(String, String, Bundle, CancellationSignal)`.
`String`	`getDocumentType(String documentId)` Return concrete MIME type of the requested document.
`String[]`	`getStreamTypes(Uri uri, String mimeTypeFilter)` Called by a client to determine the types of data streams that this content provider support for the given URI.
`final String`	`getType(Uri uri)` Implementation is provided by the parent class.
`final Uri`	`insert(Uri uri, ContentValues values)` Implementation is provided by the parent class.
`boolean`	`isChildDocument(String parentDocumentId, String documentId)` Test if a document is descendant (child, grandchild, etc) from the given parent.
`String`	`moveDocument(String sourceDocumentId, String sourceParentDocumentId, String targetParentDocumentId)` Move the requested document or a document tree.
`final AssetFileDescriptor`	`openAssetFile(Uri uri, String mode, CancellationSignal signal)` Implementation is provided by the parent class.
`final AssetFileDescriptor`	`openAssetFile(Uri uri, String mode)` Implementation is provided by the parent class.
`abstract ParcelFileDescriptor`	`openDocument(String documentId, String mode, CancellationSignal signal)` Open and return the requested document.
`AssetFileDescriptor`	`openDocumentThumbnail(String documentId, Point sizeHint, CancellationSignal signal)` Open and return a thumbnail of the requested document.
`final ParcelFileDescriptor`	`openFile(Uri uri, String mode, CancellationSignal signal)` Implementation is provided by the parent class.
`final ParcelFileDescriptor`	`openFile(Uri uri, String mode)` Implementation is provided by the parent class.
`final AssetFileDescriptor`	`openTypedAssetFile(Uri uri, String mimeTypeFilter, Bundle opts)` Implementation is provided by the parent class.
`final AssetFileDescriptor`	`openTypedAssetFile(Uri uri, String mimeTypeFilter, Bundle opts, CancellationSignal signal)` Implementation is provided by the parent class.
`AssetFileDescriptor`	`openTypedDocument(String documentId, String mimeTypeFilter, Bundle opts, CancellationSignal signal)` Open and return the document in a format matching the specified MIME type filter.
`final Cursor`	`query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)` Implementation is provided by the parent class.
`abstract Cursor`	`queryChildDocuments(String parentDocumentId, String[] projection, String sortOrder)` Return the children documents contained in the requested directory.
`abstract Cursor`	`queryDocument(String documentId, String[] projection)` Return metadata for the single requested document.
`Cursor`	`queryRecentDocuments(String rootId, String[] projection)` Return recently modified documents under the requested root.
`abstract Cursor`	`queryRoots(String[] projection)` Return all roots currently provided.
`Cursor`	`querySearchDocuments(String rootId, String query, String[] projection)` Return documents that match the given query under the requested root.
`void`	`removeDocument(String documentId, String parentDocumentId)` Removes the requested document or a document tree.
`String`	`renameDocument(String documentId, String displayName)` Rename an existing document.
`final void`	`revokeDocumentPermission(String documentId)` Revoke any active permission grants for the given `COLUMN_DOCUMENT_ID`, usually called when a document becomes invalid.
`final int`	`update(Uri uri, ContentValues values, String selection, String[] selectionArgs)` Implementation is provided by the parent class.

Inherited methods

From class


  
    android.content.ContentProvider

`ContentProviderResult[]`	`applyBatch(ArrayList<ContentProviderOperation> operations)` Override this to handle requests to perform a batch of operations, or the default implementation will iterate over the operations and call `apply(ContentProvider, ContentProviderResult[], int)` on each of them.
`void`	`attachInfo(Context context, ProviderInfo info)` After being instantiated, this is called to tell the content provider about itself.
`int`	`bulkInsert(Uri uri, ContentValues[] values)` Override this to handle requests to insert a set of new rows, or the default implementation will iterate over the values and call `insert(Uri, ContentValues)` on each of them.
`Bundle`	`call(String method, String arg, Bundle extras)` Call a provider-defined method.
`Uri`	`canonicalize(Uri url)` Implement this to support canonicalization of URIs that refer to your content provider.
`abstract int`	`delete(Uri uri, String selection, String[] selectionArgs)` Implement this to handle requests to delete one or more rows.
`void`	`dump(FileDescriptor fd, PrintWriter writer, String[] args)` Print the Provider's state into the given stream.
`final String`	`getCallingPackage()` Return the package name of the caller that initiated the request being processed on the current thread.
`final Context`	`getContext()` Retrieves the Context this provider is running in.
`final PathPermission[]`	`getPathPermissions()` Return the path-based permissions required for read and/or write access to this content provider.
`final String`	`getReadPermission()` Return the name of the permission required for read-only access to this content provider.
`String[]`	`getStreamTypes(Uri uri, String mimeTypeFilter)` Called by a client to determine the types of data streams that this content provider supports for the given URI.
`abstract String`	`getType(Uri uri)` Implement this to handle requests for the MIME type of the data at the given URI.
`final String`	`getWritePermission()` Return the name of the permission required for read/write access to this content provider.
`abstract Uri`	`insert(Uri uri, ContentValues values)` Implement this to handle requests to insert a new row.
`boolean`	`isTemporary()` Returns true if this instance is a temporary content provider.
`void`	`onConfigurationChanged(Configuration newConfig)` Called by the system when the device configuration changes while your component is running. This method is always called on the application main thread, and must not perform lengthy operations.
`abstract boolean`	`onCreate()` Implement this to initialize your content provider on startup.
`void`	`onLowMemory()` This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. This method is always called on the application main thread, and must not perform lengthy operations.
`void`	`onTrimMemory(int level)` Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
`AssetFileDescriptor`	`openAssetFile(Uri uri, String mode, CancellationSignal signal)` This is like `openFile(Uri, String)`, but can be implemented by providers that need to be able to return sub-sections of files, often assets inside of their .apk.
`AssetFileDescriptor`	`openAssetFile(Uri uri, String mode)` This is like `openFile(Uri, String)`, but can be implemented by providers that need to be able to return sub-sections of files, often assets inside of their .apk.
`ParcelFileDescriptor`	`openFile(Uri uri, String mode, CancellationSignal signal)` Override this to handle requests to open a file blob.
`ParcelFileDescriptor`	`openFile(Uri uri, String mode)` Override this to handle requests to open a file blob.
`final ParcelFileDescriptor`	`openFileHelper(Uri uri, String mode)` Convenience for subclasses that wish to implement `openFile(Uri, String)` by looking up a column named "_data" at the given URI.
`<T> ParcelFileDescriptor`	`openPipeHelper(Uri uri, String mimeType, Bundle opts, T args, PipeDataWriter<T> func)` A helper function for implementing `openTypedAssetFile(Uri, String, Bundle)`, for creating a data pipe and background thread allowing you to stream generated data back to the client.
`AssetFileDescriptor`	`openTypedAssetFile(Uri uri, String mimeTypeFilter, Bundle opts)` Called by a client to open a read-only stream containing data of a particular MIME type.
`AssetFileDescriptor`	`openTypedAssetFile(Uri uri, String mimeTypeFilter, Bundle opts, CancellationSignal signal)` Called by a client to open a read-only stream containing data of a particular MIME type.
`Cursor`	`query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder, CancellationSignal cancellationSignal)` Implement this to handle query requests from clients with support for cancellation.
`abstract Cursor`	`query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)` Implement this to handle query requests from clients.
`final void`	`setPathPermissions(PathPermission[] permissions)` Change the path-based permission required to read and/or write data in the content provider.
`final void`	`setReadPermission(String permission)` Change the permission required to read data from the content provider.
`final void`	`setWritePermission(String permission)` Change the permission required to read and write data in the content provider.
`void`	`shutdown()` Implement this to shut down the ContentProvider instance.
`Uri`	`uncanonicalize(Uri url)` Remove canonicalization from canonical URIs previously returned by `canonicalize(Uri)`.
`abstract int`	`update(Uri uri, ContentValues values, String selection, String[] selectionArgs)` Implement this to handle requests to update one or more rows.

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


  
    android.content.ComponentCallbacks2

From interface


  
    android.content.ComponentCallbacks

Parameters
`context`	`Context`: The context this provider is running in
`info`	`ProviderInfo`: Registered information about this content provider

Parameters
`method`	`String`: method name to call. Opaque to framework, but should not be `null`.
`arg`	`String`: provider-defined String argument. May be `null`.
`extras`	`Bundle`: provider-defined Bundle argument. May be `null`.

Parameters
`sourceDocumentId`	`String`: the document to copy.
`targetParentDocumentId`	`String`: the target document to be copied into as a child.

Parameters
`parentDocumentId`	`String`: the parent directory to create the new document under.
`mimeType`	`String`: the concrete MIME type associated with the new document. If the MIME type is not supported, the provider must throw.
`displayName`	`String`: the display name of the new document. The provider may alter this name to meet any internal constraints, such as avoiding conflicting names.

Parameters
`uri`	`Uri`: The full URI to query, including a row ID (if a specific record is requested).
`selection`	`String`: An optional restriction to apply to rows when deleting.
`selectionArgs`	`String`

Parameters
`uri`	`Uri`: The data in the content provider being queried.
`mimeTypeFilter`	`String`: The type of data the client desires. May be a pattern, such as / to retrieve all possible data types.

Parameters
`uri`	`Uri`: The content:// URI of the insertion request. This must not be `null`.
`values`	`ContentValues`: A set of column_name/value pairs to add to the database. This must not be `null`.

Parameters
`parentDocumentId`	`String`: parent to verify against.
`documentId`	`String`: child to verify.

Parameters
`sourceDocumentId`	`String`: the document to move.
`sourceParentDocumentId`	`String`: the parent of the document to move.
`targetParentDocumentId`	`String`: the target document to be a new parent of the source document.

Parameters
`uri`	`Uri`: The URI whose file is to be opened.
`mode`	`String`: Access mode for the file. May be "r" for read-only access, "w" for write-only access (erasing whatever data is currently in the file), "wa" for write-only access to append to any existing data, "rw" for read and write access on any existing data, and "rwt" for read and write access that truncates any existing file.
`signal`	`CancellationSignal`: A signal to cancel the operation in progress, or `null` if none. For example, if you are downloading a file from the network to service a "rw" mode request, you should periodically call `throwIfCanceled()` to check whether the client has canceled the request and abort the download.

Parameters
`documentId`	`String`: the document to return.
`mode`	`String`: the mode to open with, such as 'r', 'w', or 'rw'.
`signal`	`CancellationSignal`: used by the caller to signal if the request should be cancelled. May be null.

Parameters
`documentId`	`String`: the document to return.
`sizeHint`	`Point`: hint of the optimal thumbnail dimensions.
`signal`	`CancellationSignal`: used by the caller to signal if the request should be cancelled. May be null.

Parameters
`uri`	`Uri`: The URI to query. This will be the full URI sent by the client; if the client is requesting a specific record, the URI will end in a record number that the implementation should parse and add to a WHERE or HAVING clause, specifying that _id value.
`projection`	`String`: The list of columns to put into the cursor. If `null` all columns are included.
`selection`	`String`: A selection criteria to apply when filtering rows. If `null` then all rows are included.
`selectionArgs`	`String`: You may include ?s in selection, which will be replaced by the values from selectionArgs, in order that they appear in the selection. The values will be bound as Strings.
`sortOrder`	`String`: How the rows in the cursor should be sorted. If `null` then the provider is free to define the sort order.

Parameters
`parentDocumentId`	`String`: the directory to return children for.
`projection`	`String`: list of `DocumentsContract.Document` columns to put into the cursor. If `null` all supported columns should be included.
`sortOrder`	`String`: how to order the rows, formatted as an SQL `ORDER BY` clause (excluding the ORDER BY itself). Passing `null` will use the default sort order, which may be unordered. This ordering is a hint that can be used to prioritize how data is fetched from the network, but UI may always enforce a specific ordering.

Parameters
`rootId`	`String`
`projection`	`String`: list of `DocumentsContract.Document` columns to put into the cursor. If `null` all supported columns should be included.

Parameters
`rootId`	`String`: the root to search under.
`query`	`String`: string to match documents against.
`projection`	`String`: list of `DocumentsContract.Document` columns to put into the cursor. If `null` all supported columns should be included.

Parameters
`documentId`	`String`: the document to remove.
`parentDocumentId`	`String`: the parent of the document to move.

Parameters
`documentId`	`String`: the document to rename.
`displayName`	`String`: the updated display name of the document. The provider may alter this name to meet any internal constraints, such as avoiding conflicting names.

Parameters
`uri`	`Uri`: The URI to query. This can potentially have a record ID if this is an update request for a specific record.
`values`	`ContentValues`: A set of column_name/value pairs to update in the database. This must not be `null`.
`selection`	`String`: An optional filter to match rows to update.
`selectionArgs`	`String`

Most visited

Recently visited

Results for

DocumentsProvider

Documents

Roots

Summary

Inherited constants

Public constructors

Public methods

Inherited methods

Public constructors

DocumentsProvider

Public methods

attachInfo

call

canonicalize

copyDocument

createDocument

delete

deleteDocument

getDocumentStreamTypes

getDocumentType

getStreamTypes

getType

insert

isChildDocument

moveDocument

openAssetFile

openAssetFile

openDocument

openDocumentThumbnail

openFile

openFile

openTypedAssetFile

openTypedAssetFile

openTypedDocument

query

queryChildDocuments

queryDocument

queryRecentDocuments

queryRoots

querySearchDocuments

removeDocument

renameDocument

revokeDocumentPermission

update