public final class Dataset
extends Object implements Parcelable

   ↳ android.service.autofill.Dataset

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

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.

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 setAuthentication(IntentSender) for more details about the dataset authentication mechanism.


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 setValue(AutofillId, AutofillValue, Pattern) or setValue(AutofillId, AutofillValue, Pattern, RemoteViews)) 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.

More information

See AutofillService for more information and examples about the role of datasets in the autofill workflow.


Nested classes

class Dataset.Builder

A builder for Dataset objects. 

Inherited constants


public static final Creator<Dataset> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods



added in API level 26
Creator<Dataset> CREATOR

Public methods


added in API level 26
int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.


added in API level 26
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

String a string representation of the object.


added in API level 26
void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

parcel Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.