Merge "Docs: Inserted links to relevant guide pages." into pi-dev

am: 283f55f7de

Change-Id: I1a42ff1b3485e35e152b354039aa5c072e0a1e70
This commit is contained in:
Laura Davis
2018-08-17 15:14:38 -07:00
committed by android-build-merger
5 changed files with 39 additions and 18 deletions

View File

@@ -41,18 +41,23 @@ import java.util.Arrays;
import java.util.List;
/**
* Assist data automatically created by the platform's implementation of assist and autofill.
* <p>This API automatically creates assist data from the platform's
* implementation of assist and autofill.
*
* <p>The structure is used for assist purposes when created by
* {@link android.app.Activity#onProvideAssistData}, {@link View#onProvideStructure(ViewStructure)},
* or {@link View#onProvideVirtualStructure(ViewStructure)}.
*
* <p>The structure is used for autofill purposes when created by
* <p>The structure is also used for autofill purposes when created by
* {@link View#onProvideAutofillStructure(ViewStructure, int)},
* or {@link View#onProvideAutofillVirtualStructure(ViewStructure, int)}.
*
* <p>For performance reasons, some properties of the assist data might be available just for assist
* or autofill purposes; in those case, the property availability will be document in its javadoc.
* <p>For performance reasons, some properties of the assist data might only be available for
* assist or autofill purposes. In those cases, a property's availability will be documented
* in its javadoc.
*
* <p>To learn about using Autofill in your app, read the
* <a href="/guide/topics/text/autofill">Autofill Framework</a> guides.
*/
public class AssistStructure implements Parcelable {
static final String TAG = "AssistStructure";

View File

@@ -33,8 +33,13 @@ import java.util.ArrayList;
import java.util.regex.Pattern;
/**
* A dataset object represents a group of fields (key / value pairs) used to autofill parts of a
* screen.
* <p>A <code>Dataset</code> object represents a group of fields (key / value pairs) used
* to autofill parts of a screen.
*
* <p>For more information about the role of datasets in the autofill workflow, read
* <a href="/guide/topics/text/autofill-services">Build autofill services</a> and the
* <code><a href="/reference/android/service/autofill/AutofillService">AutofillService</a></code>
* documentation.
*
* <a name="BasicUsage"></a>
* <h3>Basic usage</h3>
@@ -88,10 +93,6 @@ import java.util.regex.Pattern;
* <li>All other datasets are hidden.
* </ol>
*
* <a name="MoreInfo"></a>
* <h3>More information</h3>
* <p>See {@link android.service.autofill.AutofillService} for more information and examples about
* the role of datasets in the autofill workflow.
*/
public final class Dataset implements Parcelable {

View File

@@ -21,8 +21,11 @@ import android.app.Activity;
import android.os.RemoteException;
/**
* Handles autofill requests from the {@link AutofillService} into the {@link Activity} being
* autofilled.
* <p><code>FillCallback</code> handles autofill requests from the {@link AutofillService} into
* the {@link Activity} being autofilled.
*
* <p>To learn about using Autofill services in your app, read
* <a href="/guide/topics/text/autofill-services">Build autofill services</a>.
*/
public final class FillCallback {
private final IFillCallback mCallback;

View File

@@ -33,9 +33,14 @@ import com.android.internal.util.Preconditions;
import java.util.List;
/**
* Container for storing additional per-view data generated by {@link View#onProvideStructure
* <p><code>ViewStructure</code> is a container for storing additional
* per-view data generated by {@link View#onProvideStructure
* View.onProvideStructure} and {@link View#onProvideAutofillStructure
* View.onProvideAutofillStructure}.
*
* <p>To learn more about using Autofill in your app, read the
* <a href="/guide/topics/text/autofill">Autofill Framework</a> guides.
*
*/
public abstract class ViewStructure {

View File

@@ -77,11 +77,16 @@ import java.util.Objects;
import sun.misc.Cleaner;
/**
* The {@link AutofillManager} provides ways for apps and custom views to integrate with the
* Autofill Framework lifecycle.
* <p>The {@link AutofillManager} class provides ways for apps and custom views to
* integrate with the Autofill Framework lifecycle.
*
* <p>To learn about using Autofill in your app, read
* the <a href="/guide/topics/text/autofill">Autofill Framework</a> guides.
*
* <h3 id="autofill-lifecycle">Autofill lifecycle</h3>
*
* <p>The autofill lifecycle starts with the creation of an autofill context associated with an
* activity context; the autofill context is created when one of the following methods is called for
* activity context. The autofill context is created when one of the following methods is called for
* the first time in an activity context, and the current user has an enabled autofill service:
*
* <ul>
@@ -90,7 +95,7 @@ import sun.misc.Cleaner;
* <li>{@link #requestAutofill(View)}
* </ul>
*
* <p>Tipically, the context is automatically created when the first view of the activity is
* <p>Typically, the context is automatically created when the first view of the activity is
* focused because {@code View.onFocusChanged()} indirectly calls
* {@link #notifyViewEntered(View)}. App developers can call {@link #requestAutofill(View)} to
* explicitly create it (for example, a custom view developer could offer a contextual menu action
@@ -134,7 +139,9 @@ import sun.misc.Cleaner;
* shows an autofill save UI if the value of savable views have changed. If the user selects the
* option to Save, the current value of the views is then sent to the autofill service.
*
* <p>It is safe to call into its methods from any thread.
* <h3 id="additional-notes">Additional notes</h3>
*
* <p>It is safe to call <code>AutofillManager</code> methods from any thread.
*/
@SystemService(Context.AUTOFILL_MANAGER_SERVICE)
@RequiresFeature(PackageManager.FEATURE_AUTOFILL)