ActivityResultContracts.OpenDocumentTree

@RequiresApi(value = 21)
open class ActivityResultContracts.OpenDocumentTree : ActivityResultContract

kotlin.Any
   ↳ androidx.activity.result.contract.ActivityResultContract
     ↳ androidx.activity.result.contract.ActivityResultContracts.OpenDocumentTree

An ActivityResultContract to prompt the user to select a directory, returning the user selection as a Uri. Apps can fully manage documents within the returned directory.

The input is an optional Uri of the initial starting location.

This can be extended to override createIntent if you wish to pass additional extras to the Intent created by super.createIntent().

See also
ACTION_OPEN_DOCUMENT_TREE
buildDocumentUriUsingTree
buildChildDocumentsUriUsingTree

Summary

Public constructors

Public functions
open Intent
@CallSuper
createIntent(context: Context, input: Uri?)

Create an intent that can be used for android.app.Activity.startActivityForResult.
final ActivityResultContract.SynchronousResult<Uri?>?
getSynchronousResult(context: Context, input: Uri?)

An optional method you can implement that can be used to potentially provide a result in lieu of starting an activity.
final Uri?
parseResult(resultCode: Int, intent: Intent?)

Convert result obtained from android.app.Activity.onActivityResult to O.

Public constructors

OpenDocumentTree

Added in 1.2.0
OpenDocumentTree()

Public functions

createIntent

Added in 1.2.0
@CallSuper
open fun createIntent(context: Context, input: Uri?): Intent

Create an intent that can be used for android.app.Activity.startActivityForResult.

getSynchronousResult

Added in 1.2.0
final fun getSynchronousResult(context: Context, input: Uri?): ActivityResultContract.SynchronousResult<Uri?>?

An optional method you can implement that can be used to potentially provide a result in lieu of starting an activity.

Returns
ActivityResultContract.SynchronousResult<Uri?>?

the result wrapped in a SynchronousResult or null if the call should proceed to start an activity.

parseResult

Added in 1.10.0-rc01
final fun parseResult(resultCode: Int, intent: Intent?): Uri?

Convert result obtained from android.app.Activity.onActivityResult to O.