RemoteInput

public static final int EDIT_CHOICES_BEFORE_SENDING_AUTO = 0

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

public static final int EDIT_CHOICES_BEFORE_SENDING_DISABLED = 1

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

public static final 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.

public static final String EXTRA_RESULTS_DATA = "android.remoteinput.resultsData"

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

public static final String RESULTS_CLIP_LABEL = "android.remoteinput.results"

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

public static final int SOURCE_CHOICE = 1

The user selected one of the choices from getChoices.

public static final int SOURCE_FREE_FORM_INPUT = 0

The user manually entered the data.

public static void addDataResultToIntent(
    @NonNull RemoteInput remoteInput,
    @NonNull Intent intent,
    @NonNull Map<String, Uri> results
)

Same as addResultsToIntent but for setting data results.

public static void addResultsToIntent(
    @NonNull RemoteInput[] remoteInputs,
    @NonNull Intent intent,
    @NonNull Bundle results
)

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.

public boolean getAllowFreeFormInput()

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.

public @Nullable CharSequence[] getChoices()

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

public static @Nullable Map<String, Uri> getDataResultsFromIntent(
    @NonNull Intent intent,
    @NonNull String remoteInputResultKey
)

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

public int getEditChoicesBeforeSending()

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

public @NonNull Bundle getExtras()

Get additional metadata carried around with this remote input.

public @Nullable CharSequence getLabel()

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

public @NonNull 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.

public static @Nullable Bundle getResultsFromIntent(@NonNull Intent intent)

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.

public static int getResultsSource(@NonNull Intent intent)

Get the source of the RemoteInput results.

public 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.

public static void setResultsSource(@NonNull Intent intent, int source)

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.