Dataset

class Dataset : Parcelable

A Dataset object represents a group of fields (key / value pairs) used to autofill parts of a screen.

For more information about the role of datasets in the autofill workflow, read Build autofill services and the AutofillService documentation.

Basic usage

In its simplest form, a dataset contains one or more fields (comprised of an id, a value, and an optional filter regex); and one or more presentations for these fields (each field could have its own presentation, or use the default presentation associated with the whole dataset).

When an autofill service returns datasets in a FillResponse and the screen input is focused in a view that is present in at least one of these datasets, the Android System displays a UI containing the presentation of all datasets pairs that have that view's AutofillId. Then, when the user selects a dataset from the UI, all views in that dataset are autofilled.

If both the current Input Method and autofill service supports inline suggestions, the Dataset can be shown by the keyboard as a suggestion. To use this feature, the Dataset should contain an InlinePresentation representing how the inline suggestion UI will be rendered.

Fill Dialog UI

The fill dialog UI is a more conspicuous and efficient interface than dropdown UI. If autofill suggestions are available when the user clicks on a field that supports filling the dialog UI, Autofill will pop up a fill dialog. The dialog will take up a larger area to display the datasets, so it is easy for users to pay attention to the datasets and selecting a dataset. If the user focuses on the view before suggestions are available, will fall back to dropdown UI or inline suggestions.

Dataset authentication

In a more sophisticated form, the dataset values can be protected until the user authenticates the dataset—in that case, when a dataset is selected by the user, the Android System launches an intent set by the service to "unlock" the dataset.

For example, when a data set contains credit card information (such as number, expiration date, and verification code), you could provide a dataset presentation saying "Tap to authenticate". Then when the user taps that option, you would launch an activity asking the user to enter the credit card code, and if the user enters a valid code, you could then "unlock" the dataset.

You can also use authenticated datasets to offer an interactive UI for the user. For example, if the activity being autofilled is an account creation screen, you could use an authenticated dataset to automatically generate a random password for the user.

See Dataset.Builder#setAuthentication(IntentSender) for more details about the dataset authentication mechanism.

Filtering

The autofill UI automatically changes which values are shown based on value of the view anchoring it, following the rules below:

1. If the view's autofill value is not text or is empty, all datasets are shown.
2. Datasets that have a filter regex (set through Field.Builder#setFilter(Pattern) and Dataset.Builder#setField(AutofillId, Field)) and whose regex matches the view's text value converted to lower case are shown.
3. Datasets that do not require authentication, have a field value that is text and whose value starts with the lower case value of the view's text are shown.
4. All other datasets are hidden.

Note: If user enters four or more characters, all datasets will be hidden

Summary

Public methods

fun describeContents(): Int

fun toString(): String

fun writeToParcel(
    parcel: Parcel, 
    flags: Int
): Unit

Properties

static val CREATOR: Parcelable.Creator<Dataset!>