FillContext

public final class FillContext
extends Object implements Parcelable

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


This class represents a context for each fill request made via AutofillService.onFillRequest(android.service.autofill.FillRequest, android.os.CancellationSignal, android.service.autofill.FillCallback). It contains a snapshot of the UI state, the view ids that were returned by the autofill service as both required to trigger a save and optional that can be saved, and the id of the corresponding FillRequest.

This context allows you to inspect the values for the interesting views in the context they appeared. Also a reference to the corresponding fill request is useful to store meta-data in the client state bundle passed to FillResponse.Builder#setClientState(Bundle) to avoid interpreting the UI state again while saving.

Summary

Inherited constants

Fields

public static final Creator<FillContext> CREATOR

Public methods

int describeContents()

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

AutofillId getFocusedId()

The AutofillId of the view that triggered autofill.

int getRequestId()

The id of the fill request this context corresponds to.

AssistStructure getStructure()

The screen content.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 26
public static final Creator<FillContext> 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(android.os.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. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getFocusedId

Added in API level 29
public AutofillId getFocusedId ()

The AutofillId of the view that triggered autofill.

Returns
AutofillId This value cannot be null.

getRequestId

Added in API level 26
public int getRequestId ()

The id of the fill request this context corresponds to. This is useful to associate your custom client state with every request to avoid reinterpreting the UI when saving user data.

Returns
int

getStructure

Added in API level 26
public AssistStructure getStructure ()

The screen content.

Returns
AssistStructure This value cannot be null.

toString

Added in API level 26
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 26
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written. This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES