Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Improved javadocs for Autofill save workflow." into oc-mr1-dev

Browse Source
This commit is contained in:
TreeHugger Robot
2017-10-04 20:02:19 +00:00
committed by Android (Google) Code Review
parent bd8d517381 30040fa3e2
commit 94e07022c2
2 changed files with 22 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
core/java/android/service/autofill/AutofillService.java
View File

@@ -503,13 +503,19 @@ public abstract class AutofillService extends Service {
@NonNull CancellationSignal cancellationSignal, @NonNull FillCallback callback);
/**
* Called when user requests service to save the fields of a screen.
* Called when the user requests the service to save the contents of a screen.
*
* <p>Service must call one of the {@link SaveCallback} methods (like
* {@link SaveCallback#onSuccess()} or {@link SaveCallback#onFailure(CharSequence)})
* to notify the result of the request.
* to notify the Android System of the result of the request.
*
* <p><b>Note:</b> To retrieve the actual value of the field, the service should call
* <p>If the service could not handle the request right away&mdash;for example, because it must
* launch an activity asking the user to authenticate first or because the network is
* down&mdash;the service could keep the {@link SaveRequest request} and reuse it later,
* but the service must call {@link SaveCallback#onSuccess()} right away.
*
* <p><b>Note:</b> To retrieve the actual value of fields input by the user, the service
* should call
* {@link android.app.assist.AssistStructure.ViewNode#getAutofillValue()}; if it calls
* {@link android.app.assist.AssistStructure.ViewNode#getText()} or other methods, there is no
* guarantee such method will return the most recent value of the field.

15
core/java/android/service/autofill/SaveCallback.java
View File

@@ -34,9 +34,13 @@ public final class SaveCallback {
/**
* Notifies the Android System that an
* {@link AutofillService#onSaveRequest(SaveRequest, SaveCallback)} was successfully fulfilled
* {@link AutofillService#onSaveRequest(SaveRequest, SaveCallback)} was successfully handled
* by the service.
*
* <p>If the service could not handle the request right away&mdash;for example, because it must
* launch an activity asking the user to authenticate first or because the network is
* down&mdash;it should still call {@link #onSuccess()}.
*
* @throws RuntimeException if an error occurred while calling the Android System.
*/
public void onSuccess() {
@@ -51,9 +55,16 @@ public final class SaveCallback {
/**
* Notifies the Android System that an
* {@link AutofillService#onSaveRequest(SaveRequest, SaveCallback)} could not be fulfilled
* {@link AutofillService#onSaveRequest(SaveRequest, SaveCallback)} could not be handled
* by the service.
*
* <p>This method should only be called when the service could not handle the request right away
* and could not recover or retry it. If the service could retry or recover, it could keep
* the {@link SaveRequest} and call {@link #onSuccess()} instead.
*
* <p><b>Note:</b> The Android System displays an UI with the supplied error message; if
* you prefer to show your own message, call {@link #onSuccess()} instead.
*
* @param message error message to be displayed to the user.
*
* @throws RuntimeException if an error occurred while calling the Android System.