DocumentsContract

EXTRA_ERROR

String EXTRA_ERROR

Optional string included in a directory getExtras() providing an error message that should be shown to a user. For example, a provider may wish to indicate that a network error occurred. The user may choose to retry, resulting in a new query.

Constant Value: "error"

EXTRA_EXCLUDE_SELF

String EXTRA_EXCLUDE_SELF

Set this in a DocumentsUI intent to cause a package's own roots to be excluded from the roots list.

Constant Value: "android.provider.extra.EXCLUDE_SELF"

EXTRA_INFO

String EXTRA_INFO

Optional string included in a directory getExtras() providing an informational message that should be shown to a user. For example, a provider may wish to indicate that not all documents are available.

Constant Value: "info"

EXTRA_LOADING

String EXTRA_LOADING

Optional boolean flag included in a directory getExtras() indicating that a document provider is still loading data. For example, a provider has returned some results, but is still waiting on an outstanding network request. The provider must send a content changed notification when loading is finished.

Constant Value: "loading"

EXTRA_ORIENTATION

String EXTRA_ORIENTATION

Included in getExtras() when returned thumbnail should be rotated.

Constant Value: "android.provider.extra.ORIENTATION"

EXTRA_PROMPT

String EXTRA_PROMPT

Overrides the default prompt text in DocumentsUI when set in an intent.

Constant Value: "android.provider.extra.PROMPT"

PROVIDER_INTERFACE

String PROVIDER_INTERFACE

Intent action used to identify DocumentsProvider instances. This is used in the <intent-filter> of a <provider>.

Constant Value: "android.content.action.DOCUMENTS_PROVIDER"

buildChildDocumentsUri

Uri buildChildDocumentsUri (String authority, 
                String parentDocumentId)

Build URI representing the children of the target directory in a document provider. When queried, a provider will return zero or more rows with columns defined by DocumentsContract.Document.

buildChildDocumentsUriUsingTree

Uri buildChildDocumentsUriUsingTree (Uri treeUri, 
                String parentDocumentId)

Build URI representing the children of the target directory in a document provider. When queried, a provider will return zero or more rows with columns defined by DocumentsContract.Document.

However, instead of directly accessing the target directory, the returned URI will leverage access granted through a subtree URI, typically returned by ACTION_OPEN_DOCUMENT_TREE. The target directory must be a descendant (child, grandchild, etc) of the subtree.

This is typically used to access documents under a user-selected directory tree, since it doesn't require the user to separately confirm each new document access.

buildDocumentUri

Uri buildDocumentUri (String authority, 
                String documentId)

Build URI representing the target COLUMN_DOCUMENT_ID in a document provider. When queried, a provider will return a single row with columns defined by DocumentsContract.Document.

buildDocumentUriUsingTree

Uri buildDocumentUriUsingTree (Uri treeUri, 
                String documentId)

Build URI representing the target COLUMN_DOCUMENT_ID in a document provider. When queried, a provider will return a single row with columns defined by DocumentsContract.Document.

However, instead of directly accessing the target document, the returned URI will leverage access granted through a subtree URI, typically returned by ACTION_OPEN_DOCUMENT_TREE. The target document must be a descendant (child, grandchild, etc) of the subtree.

This is typically used to access documents under a user-selected directory tree, since it doesn't require the user to separately confirm each new document access.

buildRecentDocumentsUri

Uri buildRecentDocumentsUri (String authority, 
                String rootId)

Build URI representing the recently modified documents of a specific root in a document provider. When queried, a provider will return zero or more rows with columns defined by DocumentsContract.Document.

buildRootUri

Uri buildRootUri (String authority, 
                String rootId)

Build URI representing the given COLUMN_ROOT_ID in a document provider.

buildRootsUri

Uri buildRootsUri (String authority)

Build URI representing the roots of a document provider. When queried, a provider will return one or more rows with columns defined by DocumentsContract.Root.

buildSearchDocumentsUri

Uri buildSearchDocumentsUri (String authority, 
                String rootId, 
                String query)

Build URI representing a search for matching documents under a specific root in a document provider. When queried, a provider will return zero or more rows with columns defined by DocumentsContract.Document.

buildTreeDocumentUri

Uri buildTreeDocumentUri (String authority, 
                String documentId)

Build URI representing access to descendant documents of the given COLUMN_DOCUMENT_ID.

copyDocument

Uri copyDocument (ContentResolver resolver, 
                Uri sourceDocumentUri, 
                Uri targetParentDocumentUri)

Copies the given document.

createDocument

Uri createDocument (ContentResolver resolver, 
                Uri parentDocumentUri, 
                String mimeType, 
                String displayName)

Create a new document with given MIME type and display name.

deleteDocument

boolean deleteDocument (ContentResolver resolver, 
                Uri documentUri)

Delete the given document.

getDocumentId

String getDocumentId (Uri documentUri)

Extract the COLUMN_DOCUMENT_ID from the given URI.

getDocumentThumbnail

Bitmap getDocumentThumbnail (ContentResolver resolver, 
                Uri documentUri, 
                Point size, 
                CancellationSignal signal)

Return thumbnail representing the document at the given URI. Callers are responsible for their own in-memory caching.

getRootId

String getRootId (Uri rootUri)

Extract the COLUMN_ROOT_ID from the given URI.

getSearchDocumentsQuery

String getSearchDocumentsQuery (Uri searchDocumentsUri)

Extract the search query from a URI built by buildSearchDocumentsUri(String, String, String).

getTreeDocumentId

String getTreeDocumentId (Uri documentUri)

Extract the via COLUMN_DOCUMENT_ID from the given URI.

isDocumentUri

boolean isDocumentUri (Context context, 
                Uri uri)

Test if the given URI represents a DocumentsContract.Document backed by a DocumentsProvider.

isTreeUri

boolean isTreeUri (Uri uri)

Test if the given URI represents a DocumentsContract.Document tree.

moveDocument

Uri moveDocument (ContentResolver resolver, 
                Uri sourceDocumentUri, 
                Uri sourceParentDocumentUri, 
                Uri targetParentDocumentUri)

Moves the given document under a new parent.

removeDocument

boolean removeDocument (ContentResolver resolver, 
                Uri documentUri, 
                Uri parentDocumentUri)

Removes the given document from a parent directory.

In contrast to deleteDocument(ContentResolver, Uri) it requires specifying the parent. This method is especially useful if the document can be in multiple parents.

renameDocument

Uri renameDocument (ContentResolver resolver, 
                Uri documentUri, 
                String displayName)

Change the display name of an existing document.

If the underlying provider needs to create a new COLUMN_DOCUMENT_ID to represent the updated display name, that new document is returned and the original document is no longer valid. Otherwise, the original document is returned.