RemoteInput

Added in 1.1.0

Kotlin |Java

class RemoteInput

Helper for using the android.app.RemoteInput.

Summary

Nested types
`class RemoteInput.Builder` Builder class for `androidx.core.app.RemoteInput` objects.

Constants
`const Int`	`EDIT_CHOICES_BEFORE_SENDING_AUTO = 0` The platform will determine whether choices will be edited before being sent to the app.
`const Int`	`EDIT_CHOICES_BEFORE_SENDING_DISABLED = 1` Tapping on a choice should send the input immediately, without letting the user edit it.
`const Int`	`EDIT_CHOICES_BEFORE_SENDING_ENABLED = 2` Tapping on a choice should let the user edit the input before it is sent to the app.
`const String!`	`EXTRA_RESULTS_DATA = "android.remoteinput.resultsData"` Extra added to a clip data intent object to hold the text results bundle.
`const String!`	`RESULTS_CLIP_LABEL = "android.remoteinput.results"` Label used to denote the clip data type used for remote input transport
`const Int`	`SOURCE_CHOICE = 1` The user selected one of the choices from `getChoices`.
`const Int`	`SOURCE_FREE_FORM_INPUT = 0` The user manually entered the data.

Public functions
`java-static Unit`	`addDataResultToIntent( remoteInput: RemoteInput, intent: Intent, results: (Mutable)Map<String!, Uri!> )` Same as `addResultsToIntent` but for setting data results.
`java-static Unit`	`addResultsToIntent( remoteInputs: Array<RemoteInput!>, intent: Intent, results: Bundle )` Populate an intent object with the results gathered from remote input.
`Boolean`	`getAllowFreeFormInput()` Get whether or not users can provide an arbitrary value for input.
`(Mutable)Set<String!>?`	`getAllowedDataTypes()`
`Array<CharSequence!>?`	`getChoices()` Get possible input choices.
`java-static (Mutable)Map<String!, Uri!>?`	`getDataResultsFromIntent(intent: Intent, remoteInputResultKey: String)` Similar as `getResultsFromIntent` but retrieves data results for a specific RemoteInput result.
`Int`	`getEditChoicesBeforeSending()` Gets whether tapping on a choice should let the user edit the input before it is sent to the app.
`Bundle`	`getExtras()` Get additional metadata carried around with this remote input.
`CharSequence?`	`getLabel()` Get the label to display to users when collecting this input.
`String`	`getResultKey()` Get the key that the result of this input will be set in from the Bundle returned by `getResultsFromIntent` when the `android.app.PendingIntent` is sent.
`java-static Bundle?`	`getResultsFromIntent(intent: Intent)` Get the remote input text results bundle from an intent.
`java-static Int`	`getResultsSource(intent: Intent)` Get the source of the RemoteInput results.
`Boolean`	`isDataOnly()` Returns true if the input only accepts data, meaning `getAllowFreeFormInput` is false, `getChoices` is null or empty, and `getAllowedDataTypes` is non-null and not empty.
`java-static Unit`	`setResultsSource(intent: Intent, source: Int)` Set the source of the RemoteInput results.

Constants

EDIT_CHOICES_BEFORE_SENDING_AUTO

Added in 1.2.0

const val EDIT_CHOICES_BEFORE_SENDING_AUTO = 0: Int

The platform will determine whether choices will be edited before being sent to the app.

EDIT_CHOICES_BEFORE_SENDING_DISABLED

Added in 1.2.0

const val EDIT_CHOICES_BEFORE_SENDING_DISABLED = 1: Int

Tapping on a choice should send the input immediately, without letting the user edit it.

EDIT_CHOICES_BEFORE_SENDING_ENABLED

Added in 1.2.0

const val EDIT_CHOICES_BEFORE_SENDING_ENABLED = 2: Int

Tapping on a choice should let the user edit the input before it is sent to the app.

EXTRA_RESULTS_DATA

Added in 1.1.0

const val EXTRA_RESULTS_DATA = "android.remoteinput.resultsData": String!

Extra added to a clip data intent object to hold the text results bundle.

RESULTS_CLIP_LABEL

Added in 1.1.0

const val RESULTS_CLIP_LABEL = "android.remoteinput.results": String!

Label used to denote the clip data type used for remote input transport

SOURCE_CHOICE

Added in 1.1.0

const val SOURCE_CHOICE = 1: Int

The user selected one of the choices from getChoices.

SOURCE_FREE_FORM_INPUT

Added in 1.1.0

const val SOURCE_FREE_FORM_INPUT = 0: Int

The user manually entered the data.

Public functions

addDataResultToIntent

Added in 1.1.0

java-static fun addDataResultToIntent(
    remoteInput: RemoteInput,
    intent: Intent,
    results: (Mutable)Map<String!, Uri!>
): Unit

Same as addResultsToIntent but for setting data results.

Parameters
`remoteInput: RemoteInput`	The remote input for which results are being provided
`intent: Intent`	The intent to add remote input results to. The `ClipData` field of the intent will be modified to contain the results.
`results: (Mutable)Map<String!, Uri!>`	A map of mime type to the Uri result for that mime type.

addResultsToIntent

Added in 1.1.0

java-static fun addResultsToIntent(
    remoteInputs: Array<RemoteInput!>,
    intent: Intent,
    results: Bundle
): Unit

Populate an intent object with the results gathered from remote input. This method should only be called by remote input collection services when sending results to a pending intent.

Parameters
`remoteInputs: Array<RemoteInput!>`	The remote inputs for which results are being provided
`intent: Intent`	The intent to add remote inputs to. The `android.content.ClipData` field of the intent will be modified to contain the results.
`results: Bundle`	A bundle holding the remote input results. This bundle should be populated with keys matching the result keys specified in `remoteInputs` with values being the result per key.

getAllowFreeFormInput

Added in 1.1.0

fun getAllowFreeFormInput(): Boolean

Get whether or not users can provide an arbitrary value for input. If you set this to false, users must select one of the choices in getChoices. An IllegalArgumentException is thrown if you set this to false and getChoices returns null or empty.

getAllowedDataTypes

Added in 1.1.0

fun getAllowedDataTypes(): (Mutable)Set<String!>?

getChoices

Added in 1.1.0

fun getChoices(): Array<CharSequence!>?

Get possible input choices. This can be null if there are no choices to present.

getDataResultsFromIntent

Added in 1.1.0

java-static fun getDataResultsFromIntent(intent: Intent, remoteInputResultKey: String): (Mutable)Map<String!, Uri!>?

Similar as getResultsFromIntent but retrieves data results for a specific RemoteInput result. To retrieve a value use:

Map<String, Uri> results =
    RemoteInput.getDataResultsFromIntent(intent, REMOTE_INPUT_KEY);
if (results != null) {
  Uri data = results.get(MIME_TYPE_OF_INTEREST);
}

Parameters
`intent: Intent`	The intent object that fired in response to an action or content intent which also had one or more remote input requested.
`remoteInputResultKey: String`	The result key for the RemoteInput you want results for.

getEditChoicesBeforeSending

Added in 1.2.0

fun getEditChoicesBeforeSending(): Int

Gets whether tapping on a choice should let the user edit the input before it is sent to the app.

getExtras

Added in 1.1.0

fun getExtras(): Bundle

Get additional metadata carried around with this remote input.

getLabel

Added in 1.1.0

fun getLabel(): CharSequence?

Get the label to display to users when collecting this input.

getResultKey

Added in 1.1.0

fun getResultKey(): String

Get the key that the result of this input will be set in from the Bundle returned by getResultsFromIntent when the android.app.PendingIntent is sent.

getResultsFromIntent

Added in 1.1.0

java-static fun getResultsFromIntent(intent: Intent): Bundle?

Get the remote input text results bundle from an intent. The returned Bundle will contain a key/value for every result key populated by remote input collector. Use the getCharSequence method to retrieve a value. For data results use getDataResultsFromIntent.

Parameters
`intent: Intent`	The intent object that fired in response to an action or content intent which also had one or more remote input requested.

getResultsSource

Added in 1.1.0

java-static fun getResultsSource(intent: Intent): Int

Get the source of the RemoteInput results.

Parameters
`intent: Intent`	The intent object that fired in response to an action or content intent which also had one or more remote input requested.

Returns
`Int`	The source of the results. If no source was set, `SOURCE_FREE_FORM_INPUT` will be returned.

See also
`SOURCE_FREE_FORM_INPUT`
`SOURCE_CHOICE`

isDataOnly

Added in 1.1.0

fun isDataOnly(): Boolean

Returns true if the input only accepts data, meaning getAllowFreeFormInput is false, getChoices is null or empty, and getAllowedDataTypes is non-null and not empty.

setResultsSource

Added in 1.1.0

java-static fun setResultsSource(intent: Intent, source: Int): Unit

Set the source of the RemoteInput results. This method should only be called by remote input collection services (e.g. android.service.notification.NotificationListenerService) when sending results to a pending intent.

Parameters
`intent: Intent`	The intent to add remote input source to. The `ClipData` field of the intent will be modified to contain the source.
`source: Int`	The source of the results.

See also
`SOURCE_FREE_FORM_INPUT`
`SOURCE_CHOICE`

RemoteInput

Summary

Nested types

Constants

Public functions

Constants

EDIT_CHOICES_BEFORE_SENDING_AUTO

EDIT_CHOICES_BEFORE_SENDING_DISABLED

EDIT_CHOICES_BEFORE_SENDING_ENABLED

EXTRA_RESULTS_DATA

RESULTS_CLIP_LABEL

SOURCE_CHOICE

SOURCE_FREE_FORM_INPUT

Public functions

addDataResultToIntent

addResultsToIntent

getAllowFreeFormInput

getAllowedDataTypes

getChoices

getDataResultsFromIntent

getEditChoicesBeforeSending

getExtras

getLabel

getResultKey

getResultsFromIntent

getResultsSource

isDataOnly

setResultsSource