core/androidx.core.provider/DocumentsContractCompat

DocumentsContractCompat

class DocumentsContractCompat(source)

Helper for accessing features in DocumentsContract.

Types

DocumentCompat

class DocumentCompat

Helper for accessing features in DocumentsContract.Document.

Functions

buildChildDocumentsUri

@Nullable

open fun buildChildDocumentsUri(@NonNull authority: String, @Nullable parentDocumentId: String): Uri

Build URI representing the children of the target directory in a document provider.

buildChildDocumentsUriUsingTree

@Nullable

open fun buildChildDocumentsUriUsingTree(@NonNull treeUri: Uri, @NonNull parentDocumentId: String): Uri

Build URI representing the children of the target directory in a document provider.

buildDocumentUri

@Nullable

open fun buildDocumentUri(@NonNull authority: String, @NonNull documentId: String): Uri

Build URI representing the target COLUMN_DOCUMENT_ID in a document provider.

buildDocumentUriUsingTree

@Nullable

open fun buildDocumentUriUsingTree(@NonNull treeUri: Uri, @NonNull documentId: String): Uri

Build URI representing the target COLUMN_DOCUMENT_ID in a document provider.

buildTreeDocumentUri

@Nullable

open fun buildTreeDocumentUri(@NonNull authority: String, @NonNull documentId: String): Uri

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

createDocument

@Nullable

open fun createDocument(@NonNull content: ContentResolver, @NonNull parentDocumentUri: Uri, @NonNull mimeType: String, @NonNull displayName: String): Uri

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

getDocumentId

@Nullable

open fun getDocumentId(@NonNull documentUri: Uri): String

Extract the COLUMN_DOCUMENT_ID from the given URI.

getTreeDocumentId

@Nullable

open fun getTreeDocumentId(@NonNull documentUri: Uri): String

Extract the via COLUMN_DOCUMENT_ID from the given URI.

isDocumentUri

open fun isDocumentUri(@NonNull context: Context, @Nullable uri: Uri): Boolean

Checks if the given URI represents a Document backed by a DocumentsProvider.

isTreeUri

open fun isTreeUri(@NonNull uri: Uri): Boolean

Checks if the given URI represents a Document tree.

removeDocument

open fun removeDocument(@NonNull content: ContentResolver, @NonNull documentUri: Uri, @NonNull parentDocumentUri: Uri): Boolean

Removes the given document from a parent directory.

renameDocument

@Nullable

open fun renameDocument(@NonNull content: ContentResolver, @NonNull documentUri: Uri, @NonNull displayName: String): Uri

Change the display name of an existing document.