From fa458a23314018753e9b7f3c647f0f13f9b8f3cf Mon Sep 17 00:00:00 2001 From: Shane Brennan Date: Wed, 26 Apr 2017 12:27:53 -0700 Subject: Updating docs for RemoteInput non-textual inputs per API review request. Bug: 37706825 Test: Documentation-only change Change-Id: I5987868916010f1143e2d8227ea3ea7952c87bc7 (cherry picked from commit 4bff5a1f5a20afcfb5e8add044c050dcb1d74435) --- core/java/android/app/RemoteInput.java | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/core/java/android/app/RemoteInput.java b/core/java/android/app/RemoteInput.java index d1dc85931404..8ab19c06df80 100644 --- a/core/java/android/app/RemoteInput.java +++ b/core/java/android/app/RemoteInput.java @@ -118,6 +118,11 @@ public final class RemoteInput implements Parcelable { return mChoices; } + /** + * Get possible non-textual inputs that are accepted. + * This can be {@code null} if the input does not accept non-textual values. + * See {@link Builder#setAllowDataType}. + */ public Set getAllowedDataTypes() { return mAllowedDataTypes; } @@ -202,7 +207,9 @@ public final class RemoteInput implements Parcelable { } /** - * Specifies whether the user can provide arbitrary values. + * Specifies whether the user can provide arbitrary values. This allows an input + * to accept non-textual values. Examples of usage are an input that wants audio + * or an image. * * @param mimeType A mime type that results are allowed to come in. * Be aware that text results (see {@link #setAllowFreeFormInput} @@ -374,7 +381,12 @@ public final class RemoteInput implements Parcelable { } /** - * Same as {@link #addResultsToIntent} but for setting data results. + * Same as {@link #addResultsToIntent} but for setting data results. This is used + * for inputs that accept non-textual results (see {@link Builder#setAllowDataType}). + * Only one result can be provided for every mime type accepted by the RemoteInput. + * If multiple inputs of the same mime type are expected then multiple RemoteInputs + * should be used. + * * @param remoteInput The remote input for which results are being provided * @param intent The intent to add remote input results to. The {@link ClipData} * field of the intent will be modified to contain the results. -- cgit v1.2.3-59-g8ed1b