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