diff options
Diffstat (limited to 'android/service/autofill/SaveInfo.java')
| -rw-r--r-- | android/service/autofill/SaveInfo.java | 88 |
1 files changed, 17 insertions, 71 deletions
diff --git a/android/service/autofill/SaveInfo.java b/android/service/autofill/SaveInfo.java index fde2416f..1b9240cc 100644 --- a/android/service/autofill/SaveInfo.java +++ b/android/service/autofill/SaveInfo.java @@ -68,7 +68,7 @@ import java.util.Arrays; * .build(); * </pre> * - * <p>The save type flags are used to display the appropriate strings in the autofill save UI. + * <p>The save type flags are used to display the appropriate strings in the save UI affordance. * You can pass multiple values, but try to keep it short if possible. In the above example, just * {@code SaveInfo.SAVE_DATA_TYPE_PASSWORD} would be enough. * @@ -103,17 +103,13 @@ import java.util.Arrays; * .build(); * </pre> * - * <a name="TriggeringSaveRequest"></a> - * <h3>Triggering a save request</h3> - * * <p>The {@link AutofillService#onSaveRequest(SaveRequest, SaveCallback)} can be triggered after * any of the following events: * <ul> * <li>The {@link Activity} finishes. - * <li>The app explicitly calls {@link AutofillManager#commit()}. - * <li>All required views become invisible (if the {@link SaveInfo} was created with the + * <li>The app explicitly called {@link AutofillManager#commit()}. + * <li>All required views became invisible (if the {@link SaveInfo} was created with the * {@link #FLAG_SAVE_ON_ALL_VIEWS_INVISIBLE} flag). - * <li>The user clicks a specific view (defined by {@link Builder#setTriggerId(AutofillId)}. * </ul> * * <p>But it is only triggered when all conditions below are met: @@ -127,13 +123,10 @@ import java.util.Arrays; * <li>There is no {@link Dataset} in the last {@link FillResponse} that completely matches the * screen state (i.e., all required and optional fields in the dataset have the same value as * the fields in the screen). - * <li>The user explicitly tapped the autofill save UI asking to save data for autofill. + * <li>The user explicitly tapped the UI affordance asking to save data for autofill. * </ul> * - * <a name="CustomizingSaveUI"></a> - * <h3>Customizing the autofill save UI</h3> - * - * <p>The service can also customize some aspects of the autofill save UI: + * <p>The service can also customize some aspects of the save UI affordance: * <ul> * <li>Add a simple subtitle by calling {@link Builder#setDescription(CharSequence)}. * <li>Add a customized subtitle by calling @@ -219,25 +212,16 @@ public final class SaveInfo implements Parcelable { @interface SaveDataType{} /** - * Usually, a save request is only automatically <a href="#TriggeringSaveRequest">triggered</a> - * once the {@link Activity} finishes. If this flag is set, it is triggered once all saved views - * become invisible. + * Usually {@link AutofillService#onSaveRequest(SaveRequest, SaveCallback)} + * is called once the {@link Activity} finishes. If this flag is set it is called once all + * saved views become invisible. */ public static final int FLAG_SAVE_ON_ALL_VIEWS_INVISIBLE = 0x1; - /** - * By default, a save request is automatically <a href="#TriggeringSaveRequest">triggered</a> - * once the {@link Activity} finishes. If this flag is set, finishing the activity doesn't - * trigger a save request. - * - * <p>This flag is typically used in conjunction with {@link Builder#setTriggerId(AutofillId)}. - */ - public static final int FLAG_DONT_SAVE_ON_FINISH = 0x2; - /** @hide */ @IntDef( flag = true, - value = {FLAG_SAVE_ON_ALL_VIEWS_INVISIBLE, FLAG_DONT_SAVE_ON_FINISH}) + value = {FLAG_SAVE_ON_ALL_VIEWS_INVISIBLE}) @Retention(RetentionPolicy.SOURCE) @interface SaveInfoFlags{} @@ -252,7 +236,6 @@ public final class SaveInfo implements Parcelable { private final InternalValidator mValidator; private final InternalSanitizer[] mSanitizerKeys; private final AutofillId[][] mSanitizerValues; - private final AutofillId mTriggerId; private SaveInfo(Builder builder) { mType = builder.mType; @@ -276,7 +259,6 @@ public final class SaveInfo implements Parcelable { mSanitizerValues[i] = builder.mSanitizers.valueAt(i); } } - mTriggerId = builder.mTriggerId; } /** @hide */ @@ -338,12 +320,6 @@ public final class SaveInfo implements Parcelable { return mSanitizerValues; } - /** @hide */ - @Nullable - public AutofillId getTriggerId() { - return mTriggerId; - } - /** * A builder for {@link SaveInfo} objects. */ @@ -362,7 +338,6 @@ public final class SaveInfo implements Parcelable { private ArrayMap<InternalSanitizer, AutofillId[]> mSanitizers; // Set used to validate against duplicate ids. private ArraySet<AutofillId> mSanitizerIds; - private AutofillId mTriggerId; /** * Creates a new builder. @@ -419,15 +394,13 @@ public final class SaveInfo implements Parcelable { /** * Sets flags changing the save behavior. * - * @param flags {@link #FLAG_SAVE_ON_ALL_VIEWS_INVISIBLE}, - * {@link #FLAG_DONT_SAVE_ON_FINISH}, or {@code 0}. + * @param flags {@link #FLAG_SAVE_ON_ALL_VIEWS_INVISIBLE} or {@code 0}. * @return This builder. */ public @NonNull Builder setFlags(@SaveInfoFlags int flags) { throwIfDestroyed(); - mFlags = Preconditions.checkFlagsArgument(flags, - FLAG_SAVE_ON_ALL_VIEWS_INVISIBLE | FLAG_DONT_SAVE_ON_FINISH); + mFlags = Preconditions.checkFlagsArgument(flags, FLAG_SAVE_ON_ALL_VIEWS_INVISIBLE); return this; } @@ -520,8 +493,8 @@ public final class SaveInfo implements Parcelable { } /** - * Sets an object used to validate the user input - if the input is not valid, the - * autofill save UI is not shown. + * Sets an object used to validate the user input - if the input is not valid, the Save UI + * affordance is not shown. * * <p>Typically used to validate credit card numbers. Examples: * @@ -547,7 +520,7 @@ public final class SaveInfo implements Parcelable { * ); * </pre> * - * <p><b>Note:</b> the example above is just for illustrative purposes; the same validator + * <p><b>NOTE: </b>the example above is just for illustrative purposes; the same validator * could be created using a single regex for the {@code OR} part: * * <pre class="prettyprint"> @@ -642,27 +615,6 @@ public final class SaveInfo implements Parcelable { return this; } - /** - * Explicitly defines the view that should commit the autofill context when clicked. - * - * <p>Usually, the save request is only automatically - * <a href="#TriggeringSaveRequest">triggered</a> after the activity is - * finished or all relevant views become invisible, but there are scenarios where the - * autofill context is automatically commited too late - * —for example, when the activity manually clears the autofillable views when a - * button is tapped. This method can be used to trigger the autofill save UI earlier in - * these scenarios. - * - * <p><b>Note:</b> This method should only be used in scenarios where the automatic workflow - * is not enough, otherwise it could trigger the autofill save UI when it should not— - * for example, when the user entered invalid credentials for the autofillable views. - */ - public @NonNull Builder setTriggerId(@NonNull AutofillId id) { - throwIfDestroyed(); - mTriggerId = Preconditions.checkNotNull(id); - return this; - } - /** * Builds a new {@link SaveInfo} instance. * @@ -700,14 +652,13 @@ public final class SaveInfo implements Parcelable { .append(", description=").append(mDescription) .append(DebugUtils.flagsToString(SaveInfo.class, "NEGATIVE_BUTTON_STYLE_", mNegativeButtonStyle)) - .append(", flags=").append(mFlags) - .append(", customDescription=").append(mCustomDescription) - .append(", validator=").append(mValidator) + .append(", mFlags=").append(mFlags) + .append(", mCustomDescription=").append(mCustomDescription) + .append(", validation=").append(mValidator) .append(", sanitizerKeys=") .append(mSanitizerKeys == null ? "N/A:" : mSanitizerKeys.length) .append(", sanitizerValues=") .append(mSanitizerValues == null ? "N/A:" : mSanitizerValues.length) - .append(", triggerId=").append(mTriggerId) .append("]").toString(); } @@ -736,7 +687,6 @@ public final class SaveInfo implements Parcelable { parcel.writeParcelableArray(mSanitizerValues[i], flags); } } - parcel.writeParcelable(mTriggerId, flags); parcel.writeInt(mFlags); } @@ -777,10 +727,6 @@ public final class SaveInfo implements Parcelable { builder.addSanitizer(sanitizers[i], autofillIds); } } - final AutofillId triggerId = parcel.readParcelable(null); - if (triggerId != null) { - builder.setTriggerId(triggerId); - } builder.setFlags(parcel.readInt()); return builder.build(); } |