AutofillFramework
Input
com.example.android.autofillframework
26
26
26
PUBLISHED
Input, Android O Preview
Android
Java
Mobile
ADVANCED
screenshots/icon-web.png
![]()
screenshots/1_MainPage.png
![]()
screenshots/2_SampleLoginEditTexts.png
![]()
screenshots/3_SampleLoginEditTextsAutofilled.png
![]()
screenshots/4_WelcomeActivity.png
![]()
screenshots/5_SampleLoginCustomVirtualView.png
![]()
screenshots/6_SampleLoginCustomVirtualViewAutofilled.png
![]()
screenshots/7_SampleCheckOutSpinnersAutofillable.png
![]()
screenshots/8_SampleCheckOutSpinnersAutofilled.png
![]()
screenshots/9_SettingsActivity.png
![]()
screenshots/10_AuthNeeded.png
![]()
screenshots/11_AuthActivity.png
android.view.View
android.service.autofill.AutoFillService
android.view.autofill.AutoFillManager
**System** > **Languages & Input** > **Advanced** > **Auto-fill service** and select the sample
app. To edit the service's settings, tap the settings icon next to the **Auto-fill service** list
item or open the **Autofill Settings** launcher icon.. Here, you can set whether you want to enable
authentication on the entire autofill Response or just on individual autofill datasets. You should
also set the master password to “unlock” authenticated autofill data with.
**Note:** This sample service stores all autofill data in SharedPreferences and thus is not secure.
Be careful about what you store when experimenting with the sample because anyone with root access
to your device will be able to view your autofill data.
The client side of the app has three Activities that each have autofillable fields. The first
Activity uses standard views to comprise a login form. Very little needs to be done by the client
app to ensure the views get autofilled properly. The second Activity uses a custom view with
virtual children, meaning some autofillable child views are not known to the View hierarchy to be
child views. Supporting autofill on these child views is a little more involved.
The following code snippet shows how to signal to the autofill service that a specific
autofillable virtual view has come into focus:
```java
class CustomVirtualView {
...
// Cache AutofillManager system service
mAutofillManager = context.getSystemService(AutofillManager.class);
...
// Notify service which virtual view has come into focus.
mAutofillManager.notifyViewEntered(CustomVirtualView.this, id, absBounds);
...
// Notify service that a virtual view has left focus.
mAutofillManager.notifyViewExited(CustomVirtualView.this, id);
}
```
Now that the autofillable view has signaled to the service that it has been autofilled, it needs
to provide the virtual view hierarchy to the Autofill service. This is done out of the box for
views part of the UI toolkit, but you need to implement this yourself if you have the view has
virtual child views. The following code example shows the `View` method you have to override in
order to provide this view hierarchy data to the Autofill service.
```java
@Override
public void onProvideAutofillVirtualStructure(ViewStructure structure, int flags) {
// Build a ViewStructure that will get passed to the AutofillService by the framework
// when it is time to find autofill suggestions.
structure.setClassName(getClass().getName());
int childrenSize = mItems.size();
int index = structure.addChildCount(childrenSize);
// Traverse through the view hierarchy, including virtual child views. For each view, we
// need to set the relevant autofill metadata and add it to the ViewStructure.
for (int i = 0; i < childrenSize; i++) {
Item item = mItems.valueAt(i);
ViewStructure child = structure.newChild(index);
child.setAutofillId(structure, item.id);
child.setAutofillHints(item.hints);
child.setAutofillType(item.type);
child.setDataIsSensitive(!item.sanitized);
child.setText(item.text);
child.setAutofillValue(AutofillValue.forText(item.text));
child.setFocused(item.focused);
child.setId(item.id, getContext().getPackageName(), null, item.line.idEntry);
child.setClassName(item.getClassName());
index++;
}
}
```
After the service processes the Autofill request and sends back a series of Autofill `Datasets`
(wrapped in a `Response` object), the user can pick which `Dataset` they want to autofill their
views with. When a `Dataset` is selected, this method is invoked for all of the views that were
associated with that `Dataset` by the service. For example, the `Dataset` might contain Autofill
values for username, password, birthday, and address. This method would then be invoked on all
four of those fields. The following code example shows how the sample app implements the method
to deliver a UI update to the appropriate child view after the user makes their selection.
```java
@Override
public void autofill(SparseArray values) {
// User has just selected a Dataset from the list of autofill suggestions.
// The Dataset is comprised of a list of AutofillValues, with each AutofillValue meant
// to fill a specific autofillable view. Now we have to update the UI based on the
// AutofillValues in the list.
for (int i = 0; i < values.size(); i++) {
final int id = values.keyAt(i);
final AutofillValue value = values.valueAt(i);
final Item item = mItems.get(id);
if (item != null && item.editable) {
// Set the item's text to the text wrapped in the AutofillValue.
item.text = value.getTextValue();
} else if (item == null) {
// Component not found, so no-op.
} else {
// Component not editable, so no-op.
}
}
postInvalidate();
}
```
]]>