# Print output for @column tags ?>
public
final
class
Dataset
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.service.autofill.Dataset |
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.
In its simplest form, a dataset contains one or more fields (comprised of
an AutofillId
, a AutofillValue
, and an optional filter
Pattern
); and one or more RemoteViews
for these fields
(each field could have its own RemoteViews
, or use the default
RemoteViews
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 RemoteViews
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.
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.
The autofill UI automatically changes which values are shown based on value of the view anchoring it, following the rules below:
autofill value
is not
AutofillValue#isText()
or is empty, all datasets are shown.
Dataset.Builder#setValue(AutofillId, AutofillValue, Pattern)
or
Dataset.Builder#setValue(AutofillId, AutofillValue, Pattern, RemoteViews)
) and whose
regex matches the view's text value converted to lower case are shown.
AutofillValue#isText()
and whose AutofillValue#getTextValue()
starts
with the lower case value of the view's text are shown.
Nested classes | |
---|---|
class |
Dataset.Builder
A builder for |
Inherited constants |
---|
Fields | |
---|---|
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 | |
---|---|
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 |
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. |
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 .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |