RemoteInput

const val EDIT_CHOICES_BEFORE_SENDING_AUTO = 0: Int

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

const val EDIT_CHOICES_BEFORE_SENDING_DISABLED = 1: Int

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

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.

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

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

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

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

const val SOURCE_CHOICE = 1: Int

The user selected one of the choices from getChoices.

const val SOURCE_FREE_FORM_INPUT = 0: Int

The user manually entered the data.

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

Same as addResultsToIntent but for setting data results.

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.

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.

fun getChoices(): Array<CharSequence!>?

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

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);
}

fun getEditChoicesBeforeSending(): Int

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

fun getExtras(): Bundle

Get additional metadata carried around with this remote input.

fun getLabel(): CharSequence?

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

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.

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.

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

Get the source of the RemoteInput results.

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.

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.