Added in API level 33
Field
public
final
class
Field
extends Object
| java.lang.Object | |
| ↳ | android.service.autofill.Field |
This class is used to set all information of a field. Such as the AutofillValue
to be autofilled, a explicit filter, and presentations to be
visualized, etc.
Summary
Nested classes | |
|---|---|
class |
Field.Builder
A builder for |
Public methods | |
|---|---|
Pattern
|
getFilter()
Regex used to determine if the dataset should be shown in the autofill UI;
when |
Presentations
|
getPresentations()
The presentations used to visualize this field in Autofill UI. |
AutofillValue
|
getValue()
The value to be autofilled. |
Inherited methods | |
|---|---|
Public methods
getFilter
Added in API level 33
public Pattern getFilter ()
Regex used to determine if the dataset should be shown in the autofill UI;
when null, it disables filtering on that dataset (this is the recommended
approach when value is not null and field contains sensitive data
such as passwords).
| Returns | |
|---|---|
Pattern |
|
getPresentations
Added in API level 33
public Presentations getPresentations ()
The presentations used to visualize this field in Autofill UI.
| Returns | |
|---|---|
Presentations |
This value may be null. |
getValue
Added in API level 33
public AutofillValue getValue ()
The value to be autofilled. Pass null if you do not have the value
but the target view is a logical part of the dataset. For example, if the
dataset needs authentication and you have no access to the value.
| Returns | |
|---|---|
AutofillValue |
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# Field\n\nAdded in [API level 33](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Nested Classes](#nestedclasses) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nField\n=====\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/service/autofill/Field \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\n\nfinal\n\nclass\nField\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|--------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.service.autofill.Field |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nThis class is used to set all information of a field. Such as the [AutofillValue](/reference/android/view/autofill/AutofillValue)\nto be autofilled, a [explicit filter](#Filtering), and presentations to be\nvisualized, etc.\n\nSummary\n-------\n\n| ### Nested classes ||\n|----------|-------------------------------------------------------------------------------------------------------------------------------------|\n| ` class` | [Field.Builder](/reference/android/service/autofill/Field.Builder) A builder for [Field](/reference/android/service/autofill/Field) |\n\n| ### Public methods ||\n|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[Pattern](/reference/java/util/regex/Pattern) | ` `[getFilter](/reference/android/service/autofill/Field#getFilter())`() ` Regex used to determine if the dataset should be shown in the autofill UI; when `null`, it disables filtering on that dataset (this is the recommended approach when `value` is not `null` and field contains sensitive data such as passwords). |\n| ` `[Presentations](/reference/android/service/autofill/Presentations) | ` `[getPresentations](/reference/android/service/autofill/Field#getPresentations())`() ` The presentations used to visualize this field in Autofill UI. |\n| ` `[AutofillValue](/reference/android/view/autofill/AutofillValue) | ` `[getValue](/reference/android/service/autofill/Field#getValue())`() ` The value to be autofilled. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic methods\n--------------\n\n### getFilter\n\nAdded in [API level 33](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic Pattern getFilter ()\n```\n\nRegex used to determine if the dataset should be shown in the autofill UI;\nwhen `null`, it disables filtering on that dataset (this is the recommended\napproach when `value` is not `null` and field contains sensitive data\nsuch as passwords).\n\n\u003cbr /\u003e\n\n| Returns ||\n|-----------------------------------------------|--------|\n| [Pattern](/reference/java/util/regex/Pattern) | \u003cbr /\u003e |\n\n### getPresentations\n\nAdded in [API level 33](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic Presentations getPresentations ()\n```\n\nThe presentations used to visualize this field in Autofill UI.\n\n\u003cbr /\u003e\n\n| Returns ||\n|--------------------------------------------------------------------|----------------------------------|\n| [Presentations](/reference/android/service/autofill/Presentations) | This value may be `null`. \u003cbr /\u003e |\n\n### getValue\n\nAdded in [API level 33](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic AutofillValue getValue ()\n```\n\nThe value to be autofilled. Pass `null` if you do not have the value\nbut the target view is a logical part of the dataset. For example, if the\ndataset needs authentication and you have no access to the value.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-----------------------------------------------------------------|--------|\n| [AutofillValue](/reference/android/view/autofill/AutofillValue) | \u003cbr /\u003e |"]]