ActivityResultContract

Artifact: androidx.activity:activity

View Source

Added in 1.2.0

---

Kotlin |Java

abstract class ActivityResultContract<I : Any?, O : Any?>

Known direct subclasses

ActivityResultContracts.CaptureVideo, ActivityResultContracts.CreateDocument, ActivityResultContracts.GetContent, ActivityResultContracts.GetMultipleContents, ActivityResultContracts.OpenDocumentTree, ActivityResultContracts.OpenDocument, ActivityResultContracts.OpenMultipleDocuments, ActivityResultContracts.PickContact, ActivityResultContracts.PickMultipleVisualMedia, ActivityResultContracts.PickVisualMedia, ActivityResultContracts.RequestMultiplePermissions, ActivityResultContracts.RequestPermission, ActivityResultContracts.StartActivityForResult, ActivityResultContracts.StartIntentSenderForResult, ActivityResultContracts.TakePicturePreview, ActivityResultContracts.TakePicture, ActivityResultContracts.TakeVideo, ExerciseRouteRequestContract, HealthPermissionsRequestContract, WatchFaceEditorContract

ActivityResultContracts.CaptureVideo	An ActivityResultContract to take a video saving it into the provided content-Uri.
ActivityResultContracts.CreateDocument	An ActivityResultContract to prompt the user to select a path for creating a new document of the given mimeType, returning the content: Uri of the item that was created.
ActivityResultContracts.GetContent	An ActivityResultContract to prompt the user to pick a piece of content, receiving a content:// Uri for that content that allows you to use android.content.ContentResolver.openInputStream to access the raw data.
ActivityResultContracts.GetMultipleContents	An ActivityResultContract to prompt the user to pick one or more a pieces of content, receiving a content:// Uri for each piece of content that allows you to use android.content.ContentResolver.openInputStream to access the raw data.
ActivityResultContracts.OpenDocumentTree	An ActivityResultContract to prompt the user to select a directory, returning the user selection as a Uri.
ActivityResultContracts.OpenDocument	An ActivityResultContract to prompt the user to open a document, receiving its contents as a file:/http:/content: Uri.
ActivityResultContracts.OpenMultipleDocuments	An ActivityResultContract to prompt the user to open (possibly multiple) documents, receiving their contents as file:/http:/content: Uris.
ActivityResultContracts.PickContact	An ActivityResultContract to request the user to pick a contact from the contacts app.
ActivityResultContracts.PickMultipleVisualMedia	An ActivityResultContract to use the Photo Picker to select multiple images, videos, or other types of visual media.
ActivityResultContracts.PickVisualMedia	An ActivityResultContract to use the Photo Picker to select a single image, video, or other type of visual media.
ActivityResultContracts.RequestMultiplePermissions	An ActivityResultContract to request permissions
ActivityResultContracts.RequestPermission	An ActivityResultContract to request a permission
ActivityResultContracts.StartActivityForResult	An ActivityResultContract that doesn't do any type conversion, taking raw Intent as an input and ActivityResult as an output.
ActivityResultContracts.StartIntentSenderForResult	An ActivityResultContract that calls Activity.startIntentSender.
ActivityResultContracts.TakePicturePreview	An ActivityResultContract to take small a picture preview, returning it as a Bitmap.
ActivityResultContracts.TakePicture	An ActivityResultContract to take a picture saving it into the provided content-Uri.
ActivityResultContracts.TakeVideo	This class is deprecated. The thumbnail bitmap is rarely returned and is not a good signal to determine whether the video was actually successfully captured.
ExerciseRouteRequestContract	An ActivityResultContract to request a route associated with an androidx.health.connect.client.records.ExerciseSessionRecord.
HealthPermissionsRequestContract	An ActivityResultContract to request Health permissions.
WatchFaceEditorContract	This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

---

A contract specifying that an activity can be called with an input of type I and produce an output of type O.

Makes calling an activity for result type-safe.

See also
ActivityResultCaller

Summary

Nested types
class ActivityResultContract.SynchronousResult<T : Any?> The wrapper for a result provided in getSynchronousResult.

Public constructors
<I : Any?, O : Any?> ActivityResultContract()

Public functions
abstract Intent	createIntent(context: Context, input: I) Create an intent that can be used for android.app.Activity.startActivityForResult.
open ActivityResultContract.SynchronousResult<O>?	getSynchronousResult(context: Context, input: I) An optional method you can implement that can be used to potentially provide a result in lieu of starting an activity.
abstract O	parseResult(resultCode: Int, intent: Intent?) Convert result obtained from android.app.Activity.onActivityResult to O.

Public constructors

ActivityResultContract

<I : Any?, O : Any?> ActivityResultContract()

Public functions

createIntent

Added in 1.2.0

abstract fun createIntent(context: Context, input: I): Intent

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

getSynchronousResult

Added in 1.2.0

open fun getSynchronousResult(context: Context, input: I): ActivityResultContract.SynchronousResult<O>?

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

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

parseResult

Added in 1.2.0

abstract fun parseResult(resultCode: Int, intent: Intent?): O

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