1 2 Android AutofillFramework Sample 3 =================================== 4 5 This sample demonstrates the use of the Autofill Framework. It includes implementations of client 6 Activities with views that should be autofilled, and a Service that can provide autofill data to 7 client Activities. 8 9 Introduction 10 ------------ 11 12 This sample demonstrates the use of the Autofill framework from the service side and the client 13 side. In practice, only a small handful of apps will develop Autofill services because a device 14 will only have one service as default at a time, and there is just a small number of 3rd-party apps 15 providing these services (typically password managers). However, all apps targeting O with any 16 autofillable fields should follow the necessary steps to 1) ensure their views can be autofilled 17 and 2) optimize their autofill performance. Most of the time, there is little to no extra code 18 involved, but the use of custom views and views with virtual child views requires more work. 19 20 The sample's Autofill service is implemented to parse the client's view hierarchy in search of 21 autofillable fields that it has data for. If such fields exist in the hierarchy, the service sends 22 data suggestions to the client to autofill those fields. The client uses the following attributes 23 to specify autofill properties: `importantForAutofill`, `autofillHints`, and `autofillType`. 24 `importantForAutofill` specifies whether the view is autofillable. `autofillHints` is a list of 25 strings that hint to the service **what** data to fill the view with. This sample service only 26 supports the hints listed [here](https://developer.android.com/reference/android/view/View.html#AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE) 27 with the prefix AUTOFILL_HINT_*. `autofillType` tells the service the type of data it expects to 28 receive (i.e. a list index, a date, or a string). Specifying `autofillType` is only necessary 29 when implementing a custom view since all of the provided widgets in the UI toolkit do this for you. 30 31 To set the device's default Autofill service to the one in the sample, edit **Settings** > 32 **System** > **Languages & Input** > **Advanced** > **Auto-fill service** and select the sample 33 app. To edit the service's settings, tap the settings icon next to the **Auto-fill service** list 34 item or open the **Autofill Settings** launcher icon.. Here, you can set whether you want to enable 35 authentication on the entire autofill Response or just on individual autofill datasets. You should 36 also set the master password to unlock authenticated autofill data with. 37 38 **Note:** This sample service stores all autofill data in SharedPreferences and thus is not secure. 39 Be careful about what you store when experimenting with the sample because anyone with root access 40 to your device will be able to view your autofill data. 41 42 The client side of the app has three Activities that each have autofillable fields. The first 43 Activity uses standard views to comprise a login form. Very little needs to be done by the client 44 app to ensure the views get autofilled properly. The second Activity uses a custom view with 45 virtual children, meaning some autofillable child views are not known to the View hierarchy to be 46 child views. Supporting autofill on these child views is a little more involved. 47 48 The following code snippet shows how to signal to the autofill service that a specific 49 autofillable virtual view has come into focus: 50 51 ```kotlin 52 class CustomVirtualView(context: Context, attrs: AttributeSet) : View(context, attrs) { 53 ... 54 // Cache AutofillManager system service 55 private val autofillManager: AutofillManager = context.getSystemService(AutofillManager::class.java) 56 ... 57 // Notify service which virtual view has come into focus. 58 autofillManager.notifyViewEntered(this@CustomVirtualView, id, absBounds) 59 ... 60 // Notify service that a virtual view has left focus. 61 autofillManager.notifyViewExited(this@CustomVirtualView, id) 62 } 63 ``` 64 65 Now that the autofillable view has signaled to the service that it has been autofilled, it needs 66 to provide the virtual view hierarchy to the Autofill service. This is done out of the box for 67 views part of the UI toolkit, but you need to implement this yourself if you have the view has 68 virtual child views. The following code example shows the `View` method you have to override in 69 order to provide this view hierarchy data to the Autofill service. 70 71 ```kotlin 72 override fun onProvideAutofillVirtualStructure(structure: ViewStructure, flags: Int) { 73 // Build a ViewStructure to pack in AutoFillService requests. 74 structure.setClassName(javaClass.name) 75 val childrenSize = items.size() 76 Log.d(TAG, "onProvideAutofillVirtualStructure(): flags = " + flags + ", items = " 77 + childrenSize + ", extras: " + bundleToString(structure.extras)) 78 var index = structure.addChildCount(childrenSize) 79 // Traverse through the view hierarchy, including virtual child views. For each view, we 80 // need to set the relevant autofill metadata and add it to the ViewStructure. 81 for (i in 0..childrenSize - 1) { 82 val item = items.valueAt(i) 83 Log.d(TAG, "Adding new child at index $index: $item") 84 val child = structure.newChild(index) 85 child.setAutofillId(structure, item.id) 86 child.setAutofillHints(item.hints) 87 child.setAutofillType(item.type) 88 child.setDataIsSensitive(!item.sanitized) 89 child.text = item.text 90 child.setAutofillValue(AutofillValue.forText(item.text)) 91 child.setFocused(item.focused) 92 child.setId(item.id, context.packageName, null, item.line.idEntry) 93 child.setClassName(item.className) 94 index++ 95 } 96 } 97 ``` 98 99 After the service processes the Autofill request and sends back a series of Autofill `Datasets` 100 (wrapped in a `Response` object), the user can pick which `Dataset` they want to autofill their 101 views with. When a `Dataset` is selected, this method is invoked for all of the views that were 102 associated with that `Dataset` by the service. For example, the `Dataset` might contain Autofill 103 values for username, password, birthday, and address. This method would then be invoked on all 104 four of those fields. The following code example shows how the sample app implements the method 105 to deliver a UI update to the appropriate child view after the user makes their selection. 106 107 ```kotlin 108 override fun autofill(values: SparseArray<AutofillValue>) { 109 // User has just selected a Dataset from the list of autofill suggestions. 110 // The Dataset is comprised of a list of AutofillValues, with each AutofillValue meant 111 // to fill a specific autofillable view. Now we have to update the UI based on the 112 // AutofillValues in the list. 113 for (i in 0..values.size() - 1) { 114 val id = values.keyAt(i) 115 val value = values.valueAt(i) 116 items[id]?.let { item -> 117 if (item.editable) { 118 // Set the item's text to the text wrapped in the AutofillValue. 119 item.text = value.textValue 120 } else { 121 // Component not editable, so no-op. 122 } 123 } 124 } 125 postInvalidate() 126 } 127 ``` 128 129 Pre-requisites 130 -------------- 131 132 - Android SDK Preview O 133 - Android Studio 3.0+ 134 - Android Build Tools v26+ 135 - Android Support Repository v26+ 136 - Gradle v3.0+ 137 138 Screenshots 139 ------------- 140 141 <img src="screenshots/1_MainPage.png" height="400" alt="Screenshot"/> <img src="screenshots/2_SampleLoginEditTexts.png" height="400" alt="Screenshot"/> <img src="screenshots/3_SampleLoginEditTextsAutofilled.png" height="400" alt="Screenshot"/> <img src="screenshots/4_WelcomeActivity.png" height="400" alt="Screenshot"/> <img src="screenshots/5_SampleLoginCustomVirtualView.png" height="400" alt="Screenshot"/> <img src="screenshots/6_SampleLoginCustomVirtualViewAutofilled.png" height="400" alt="Screenshot"/> <img src="screenshots/7_SampleCheckOutSpinnersAutofillable.png" height="400" alt="Screenshot"/> <img src="screenshots/8_SampleCheckOutSpinnersAutofilled.png" height="400" alt="Screenshot"/> <img src="screenshots/9_SettingsActivity.png" height="400" alt="Screenshot"/> <img src="screenshots/10_AuthNeeded.png" height="400" alt="Screenshot"/> <img src="screenshots/11_AuthActivity.png" height="400" alt="Screenshot"/> 142 143 Getting Started 144 --------------- 145 146 This sample uses the Gradle build system. To build this project, use the 147 "gradlew build" command or use "Import Project" in Android Studio. 148 149 Support 150 ------- 151 152 - Google+ Community: https://plus.google.com/communities/105153134372062985968 153 - Stack Overflow: http://stackoverflow.com/questions/tagged/android 154 155 If you've found an error in this sample, please file an issue: 156 https://github.com/googlesamples/android-AutofillFramework 157 158 Patches are encouraged, and may be submitted by forking this project and 159 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details. 160 161 License 162 ------- 163 164 Copyright 2017 The Android Open Source Project, Inc. 165 166 Licensed to the Apache Software Foundation (ASF) under one or more contributor 167 license agreements. See the NOTICE file distributed with this work for 168 additional information regarding copyright ownership. The ASF licenses this 169 file to you under the Apache License, Version 2.0 (the "License"); you may not 170 use this file except in compliance with the License. You may obtain a copy of 171 the License at 172 173 http://www.apache.org/licenses/LICENSE-2.0 174 175 Unless required by applicable law or agreed to in writing, software 176 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 177 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 178 License for the specific language governing permissions and limitations under 179 the License. 180
