Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

SaveInfo

public final class SaveInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.service.autofill.SaveInfo


Information used to indicate that an AutofillService is interested on saving the user-inputed data for future use, through a AutofillService.onSaveRequest(SaveRequest, SaveCallback) call.

A SaveInfo is always associated with a FillResponse, and it contains at least two pieces of information:

  1. The type(s) of user data (like password or credit card info) that would be saved.
  2. The minimum set of views (represented by their AutofillId) that need to be changed to trigger a save request.

Typically, the SaveInfo contains the same ids as the Dataset:

   new FillResponse.Builder()
       .addDataset(new Dataset.Builder()
           .setValue(id1, AutofillValue.forText("homer"), createPresentation("homer")) // username
           .setValue(id2, AutofillValue.forText("D'OH!"), createPresentation("password for homer")) // password
           .build())
       .setSaveInfo(new SaveInfo.Builder(
           SaveInfo.SAVE_DATA_TYPE_USERNAME | SaveInfo.SAVE_DATA_TYPE_PASSWORD,
           new AutofillId[] { id1, id2 }).build())
       .build();
 

The save type flags are used to display the appropriate strings in the autofill save UI. You can pass multiple values, but try to keep it short if possible. In the above example, just SaveInfo.SAVE_DATA_TYPE_PASSWORD would be enough.

There might be cases where the AutofillService knows how to fill the screen, but the user has no data for it. In that case, the FillResponse should contain just the SaveInfo, but no Datasets:

   new FillResponse.Builder()
       .setSaveInfo(new SaveInfo.Builder(SaveInfo.SAVE_DATA_TYPE_PASSWORD,
           new AutofillId[] { id1, id2 }).build())
       .build();
 

There might be cases where the user data in the AutofillService is enough to populate some fields but not all, and the service would still be interested on saving the other fields. In that case, the service could set the SaveInfo.Builder.setOptionalIds(AutofillId[]) as well:

   new FillResponse.Builder()
       .addDataset(new Dataset.Builder()
           .setValue(id1, AutofillValue.forText("742 Evergreen Terrace"),
               createPresentation("742 Evergreen Terrace")) // street
           .setValue(id2, AutofillValue.forText("Springfield"),
               createPresentation("Springfield")) // city
           .build())
       .setSaveInfo(new SaveInfo.Builder(SaveInfo.SAVE_DATA_TYPE_ADDRESS,
           new AutofillId[] { id1, id2 }) // street and  city
           .setOptionalIds(new AutofillId[] { id3, id4 }) // state and zipcode
           .build())
       .build();
 

Triggering a save request

The AutofillService.onSaveRequest(SaveRequest, SaveCallback) can be triggered after any of the following events:

But it is only triggered when all conditions below are met:

  • The SaveInfo associated with the FillResponse is not null.
  • The AutofillValues of all required views (as set by the requiredIds passed to the SaveInfo.Builder constructor are not empty.
  • The AutofillValue of at least one view (be it required or optional) has changed (i.e., it's neither the same value passed in a Dataset, nor the initial value presented in the view).
  • There is no Dataset in the last FillResponse that completely matches the screen state (i.e., all required and optional fields in the dataset have the same value as the fields in the screen).
  • The user explicitly tapped the autofill save UI asking to save data for autofill.

Customizing the autofill save UI

The service can also customize some aspects of the autofill save UI:

Summary

Nested classes

class SaveInfo.Builder

A builder for SaveInfo objects. 

Constants

int FLAG_DONT_SAVE_ON_FINISH

By default, a save request is automatically triggered once the Activity finishes.

int FLAG_SAVE_ON_ALL_VIEWS_INVISIBLE

Usually, a save request is only automatically triggered once the Activity finishes.

int NEGATIVE_BUTTON_STYLE_CANCEL

Style for the negative button of the save UI to cancel the save operation.

int NEGATIVE_BUTTON_STYLE_REJECT

Style for the negative button of the save UI to reject the save operation.

int SAVE_DATA_TYPE_ADDRESS

Type used on when the FillResponse represents a physical address (such as street, city, state, etc).

int SAVE_DATA_TYPE_CREDIT_CARD

Type used when the FillResponse represents a credit card.

int SAVE_DATA_TYPE_EMAIL_ADDRESS

Type used when the FillResponse represents just an email address, without a password.

int SAVE_DATA_TYPE_GENERIC

Type used when the service can save the contents of a screen, but cannot describe what the content is for.

int SAVE_DATA_TYPE_PASSWORD

Type used when the FillResponse represents user credentials that have a password.

int SAVE_DATA_TYPE_USERNAME

Type used when the FillResponse represents just an username, without a password.

Inherited constants

Fields

public static final Creator<SaveInfo> 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

Constants

FLAG_DONT_SAVE_ON_FINISH

added in API level 28
public static final int FLAG_DONT_SAVE_ON_FINISH

By default, a save request is automatically triggered once the Activity finishes. If this flag is set, finishing the activity doesn't trigger a save request.

This flag is typically used in conjunction with SaveInfo.Builder.setTriggerId(AutofillId).

Constant Value: 2 (0x00000002)

FLAG_SAVE_ON_ALL_VIEWS_INVISIBLE

added in API level 26
public static final int FLAG_SAVE_ON_ALL_VIEWS_INVISIBLE

Usually, a save request is only automatically triggered once the Activity finishes. If this flag is set, it is triggered once all saved views become invisible.

Constant Value: 1 (0x00000001)

NEGATIVE_BUTTON_STYLE_CANCEL

added in API level 26
public static final int NEGATIVE_BUTTON_STYLE_CANCEL

Style for the negative button of the save UI to cancel the save operation. In this case, the user tapping the negative button signals that they would prefer to not save the filled content.

Constant Value: 0 (0x00000000)

NEGATIVE_BUTTON_STYLE_REJECT

added in API level 26
public static final int NEGATIVE_BUTTON_STYLE_REJECT

Style for the negative button of the save UI to reject the save operation. This could be useful if the user needs to opt-in your service and the save prompt is an advertisement of the potential value you can add to the user. In this case, the user tapping the negative button sends a strong signal that the feature may not be useful and you may consider some backoff strategy.

Constant Value: 1 (0x00000001)

SAVE_DATA_TYPE_ADDRESS

added in API level 26
public static final int SAVE_DATA_TYPE_ADDRESS

Type used on when the FillResponse represents a physical address (such as street, city, state, etc).

Constant Value: 2 (0x00000002)

SAVE_DATA_TYPE_CREDIT_CARD

added in API level 26
public static final int SAVE_DATA_TYPE_CREDIT_CARD

Type used when the FillResponse represents a credit card.

Constant Value: 4 (0x00000004)

SAVE_DATA_TYPE_EMAIL_ADDRESS

added in API level 26
public static final int SAVE_DATA_TYPE_EMAIL_ADDRESS

Type used when the FillResponse represents just an email address, without a password.

Constant Value: 16 (0x00000010)

SAVE_DATA_TYPE_GENERIC

added in API level 26
public static final int SAVE_DATA_TYPE_GENERIC

Type used when the service can save the contents of a screen, but cannot describe what the content is for.

Constant Value: 0 (0x00000000)

SAVE_DATA_TYPE_PASSWORD

added in API level 26
public static final int SAVE_DATA_TYPE_PASSWORD

Type used when the FillResponse represents user credentials that have a password.

Constant Value: 1 (0x00000001)

SAVE_DATA_TYPE_USERNAME

added in API level 26
public static final int SAVE_DATA_TYPE_USERNAME

Type used when the FillResponse represents just an username, without a password.

Constant Value: 8 (0x00000008)

Fields

CREATOR

added in API level 26
public static final Creator<SaveInfo> CREATOR

Public methods

describeContents

added in API level 26
public 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.

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

toString

added in API level 26
public 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())
 

Returns
String a string representation of the object.

writeToParcel

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

Flatten this object in to a Parcel.

Parameters
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.PARCELABLE_WRITE_RETURN_VALUE.