FillRequest
class FillRequest : Parcelable
| kotlin.Any | |
| ↳ | android.service.autofill.FillRequest |
This class represents a request to an autofill service to interpret the screen and provide information to the system which views are interesting for saving and what are the possible ways to fill the inputs on the screen if applicable.
Summary
| Constants | |
|---|---|
| static Int |
Indicates this request was made using compatibility mode. |
| static Int |
Indicates autofill was explicitly requested by the user. |
| static Int |
Indicates the request supports fill dialog presentation for the fields, the system will send the request when the activity just started. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Bundle? |
Gets the latest client state bundle set by the service in a |
| IntentSender? |
Gets the |
| MutableList<FillContext!> |
Gets the contexts associated with each previous fill request. |
| Int |
getFlags()Gets the flags associated with this request. |
| MutableList<String!> |
getHints()Sends a list of datatypes for the Autofill Provider. |
| Int |
getId()Gets the unique id of this request. |
| InlineSuggestionsRequest? |
Gets the |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<FillRequest!> | |
Constants
FLAG_COMPATIBILITY_MODE_REQUEST
static val FLAG_COMPATIBILITY_MODE_REQUEST: Int
Indicates this request was made using compatibility mode.
Value is either 0 or a combination of the following:
Value: 2FLAG_MANUAL_REQUEST
static val FLAG_MANUAL_REQUEST: Int
Indicates autofill was explicitly requested by the user.
Users typically make an explicit request to autofill a screen in two situations:
- The app disabled autofill (using
View.setImportantForAutofill(int). - The service could not figure out how to autofill a screen (but the user knows the service has data for that app).
This flag is particularly useful for the second case. For example, the service could offer a complex UI where the user can map which screen views belong to each user data, or it could offer a simpler UI where the user picks the data for just the view used to trigger the request (that would be the view whose android.app.assist.AssistStructure.ViewNode#isFocused() method returns true).
An explicit autofill request is triggered when the android.view.autofill.AutofillManager#requestAutofill(View) or android.view.autofill.AutofillManager#requestAutofill(View, int, android.graphics.Rect) is called. For example, standard android.widget.TextView views show an AUTOFILL option in the overflow menu that triggers such request.
Value is either 0 or a combination of the following:
Value: 1FLAG_SUPPORTS_FILL_DIALOG
static valFLAG_SUPPORTS_FILL_DIALOG: Int
Deprecated: All requests would support fill dialog by default. Presence of this flag isn't needed.
Indicates the request supports fill dialog presentation for the fields, the system will send the request when the activity just started.
Value is either 0 or a combination of the following:
Value: 64Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
getClientState
fun getClientState(): Bundle?
Gets the latest client state bundle set by the service in a fill response.
Note: Prior to Android android.os.Build.VERSION_CODES#P, only client state bundles set by FillResponse.Builder.setClientState(Bundle) were considered. On Android android.os.Build.VERSION_CODES#P and higher, bundles set in the result of an authenticated request through the android.view.autofill.AutofillManager#EXTRA_CLIENT_STATE extra are also considered (and take precedence when set).
| Return | |
|---|---|
Bundle? |
The client state. This value may be null. |
getDelayedFillIntentSender
fun getDelayedFillIntentSender(): IntentSender?
Gets the IntentSender to send a delayed fill response.
The autofill service must first indicate that it wants to return a delayed FillResponse by setting FillResponse.FLAG_DELAY_FILL in a successful fill response. Then it can use this IntentSender to send an Intent with extra AutofillService.EXTRA_FILL_RESPONSE with the delayed response.
Note that this may be null if a delayed fill response is not supported for this fill request.
getFillContexts
fun getFillContexts(): MutableList<FillContext!>
Gets the contexts associated with each previous fill request.
Note: Starting on Android android.os.Build.VERSION_CODES#Q, it could also include contexts from requests whose SaveInfo had the SaveInfo.FLAG_DELAY_SAVE flag.
| Return | |
|---|---|
MutableList<FillContext!> |
This value cannot be null. |
getFlags
fun getFlags(): Int
Gets the flags associated with this request.
| Return | |
|---|---|
Int |
any combination of FLAG_MANUAL_REQUEST, FLAG_SUPPORTS_FILL_DIALOG and FLAG_COMPATIBILITY_MODE_REQUEST. Value is either 0 or a combination of the following:
|
getHints
fun getHints(): MutableList<String!>
Sends a list of datatypes for the Autofill Provider. If this is populated, Autofill Provider should return data for the autofill hints requested here, even though the Autofill Provider may not have detected these types. The hints would be part of HintConstants: https://developer.android.com/reference/androidx/autofill/HintConstants This is populated if the platform's field detection is enabled.
| Return | |
|---|---|
MutableList<String!> |
This value cannot be null. |
getInlineSuggestionsRequest
fun getInlineSuggestionsRequest(): InlineSuggestionsRequest?
Gets the InlineSuggestionsRequest associated with this request.
Autofill Framework will send a @non-null InlineSuggestionsRequest if currently inline suggestions are supported and can be displayed. If the Autofill service wants to show inline suggestions, they may return Dataset with valid InlinePresentation.
The Autofill Service must set supportsInlineSuggestions in its XML to enable support for inline suggestions.
| Return | |
|---|---|
InlineSuggestionsRequest? |
the suggestionspec |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel: This value cannot be null. |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|