ActivityResultContracts.OpenDocumentTree

public static class ActivityResultContracts.OpenDocumentTree
extends ActivityResultContract<UriUri>

java.lang.Object
   ↳ androidx.activity.result.contract.ActivityResultContract<android.net.Uriandroid.net.Uri>
     ↳ 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 ActivityResultContract.createIntent(Context, I) if you wish to pass additional extras to the Intent created by super.createIntent().

Summary

Public constructors

OpenDocumentTree()

Public methods

Intent createIntent(Context context, Uri input)

Create an intent that can be used for Activity.startActivityForResult(Intent, int)

final SynchronousResult<Uri> getSynchronousResult(Context context, Uri input)

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

final Uri parseResult(int resultCode, Intent intent)

Convert result obtained from Activity.onActivityResult(int, int, Intent) to O

Inherited methods

Public constructors

OpenDocumentTree

public OpenDocumentTree ()

Public methods

createIntent

public Intent createIntent (Context context, 
                Uri input)

Create an intent that can be used for Activity.startActivityForResult(Intent, int)

Parameters
context Context

input Uri

Returns
Intent

getSynchronousResult

public final SynchronousResult<Uri> getSynchronousResult (Context context, 
                Uri input)

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

Parameters
context Context

input Uri

Returns
SynchronousResult<Uri> the result wrapped in a ActivityResultContract.SynchronousResult or null if the call should proceed to start an activity.

parseResult

public final Uri parseResult (int resultCode, 
                Intent intent)

Convert result obtained from Activity.onActivityResult(int, int, Intent) to O

Parameters
resultCode int

intent Intent

Returns
Uri