DocumentFile

abstract fun canRead(): Boolean

Indicates whether the current context is allowed to read from this file.

abstract fun canWrite(): Boolean

Indicates whether the current context is allowed to write to this file.

abstract fun createDirectory(displayName: String): DocumentFile?

Create a new directory as a direct child of this directory.

abstract fun createFile(mimeType: String, displayName: String): DocumentFile?

Create a new document as a direct child of this directory.

abstract fun delete(): Boolean

Deletes this file.

Note that this method does not throw IOException on failure. Callers must check the return value.

abstract fun exists(): Boolean

Returns a boolean indicating whether this file can be found.

fun findFile(displayName: String): DocumentFile?

Search through listFiles for the first document matching the given display name. Returns null when no matching document is found.

java-static fun fromFile(file: File): DocumentFile

Create a DocumentFile representing the filesystem tree rooted at the given File. This doesn't give you any additional access to the underlying files beyond what your app already has.

getUri will return file:// Uris for files explored through this tree.

java-static fun fromSingleUri(context: Context, singleUri: Uri): DocumentFile?

Create a DocumentFile representing the single document at the given Uri. This is only useful on devices running KITKAT or later, and will return null when called on earlier platform versions.

java-static fun fromTreeUri(context: Context, treeUri: Uri): DocumentFile?

Create a DocumentFile representing the document tree rooted at the given Uri. This is only useful on devices running LOLLIPOP or later, and will return null when called on earlier platform versions.

abstract fun getName(): String?

Return the display name of this document.

fun getParentFile(): DocumentFile?

Return the parent file of this document. Only defined inside of the user-selected tree; you can never escape above the top of the tree.

The underlying android.provider.DocumentsProvider only defines a forward mapping from parent to child, so the reverse mapping of child to parent offered here is purely a convenience method, and it may be incorrect if the underlying tree structure changes.

abstract fun getType(): String?

Return the MIME type of this document.

abstract fun getUri(): Uri

Return a Uri for the underlying document represented by this file. This can be used with other platform APIs to manipulate or share the underlying content. You can use isDocumentUri to test if the returned Uri is backed by a android.provider.DocumentsProvider.

abstract fun isDirectory(): Boolean

Indicates if this file represents a directory.

java-static fun isDocumentUri(context: Context, uri: Uri?): Boolean

Test if given Uri is backed by a android.provider.DocumentsProvider.

abstract fun isFile(): Boolean

Indicates if this file represents a file.

abstract fun isVirtual(): Boolean

Indicates if this file represents a virtual document.

abstract fun lastModified(): Long

Returns the time when this file was last modified, measured in milliseconds since January 1st, 1970, midnight. Returns 0 if the file does not exist, or if the modified time is unknown.

abstract fun length(): Long

Returns the length of this file in bytes. Returns 0 if the file does not exist, or if the length is unknown. The result for a directory is not defined.

abstract fun listFiles(): Array<DocumentFile!>

Returns an array of files contained in the directory represented by this file.

abstract fun renameTo(displayName: String): Boolean

Renames this file to displayName.

Note that this method does not throw IOException on failure. Callers must check the return value.

Some providers may need to create a new document to reflect the rename, potentially with a different MIME type, so getUri and getType may change to reflect the rename.

When renaming a directory, children previously enumerated through listFiles may no longer be valid.