AssistStructure
public
class
AssistStructure
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.app.assist.AssistStructure |
This API automatically creates assist data from the platform's implementation of assist and autofill.
The structure is used for assist purposes when created by
Activity.onProvideAssistData(Bundle)
, View.onProvideStructure(ViewStructure)
,
or View.onProvideVirtualStructure(ViewStructure)
.
The structure is also used for autofill purposes when created by
View.onProvideAutofillStructure(ViewStructure, int)
,
or View.onProvideAutofillVirtualStructure(ViewStructure, int)
.
For performance reasons, some properties of the assist data might only be available for assist or autofill purposes. In those cases, a property's availability will be documented in its javadoc.
To learn about using Autofill in your app, read the Autofill Framework guides.
Summary
Nested classes | |
---|---|
class |
AssistStructure.ViewNode
Describes a single view in the assist data. |
class |
AssistStructure.WindowNode
Describes a window in the assist data. |
Inherited constants | ||||
---|---|---|---|---|
|
Fields | |
---|---|
public
static
final
Creator<AssistStructure> |
CREATOR
|
Public constructors | |
---|---|
AssistStructure()
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
long
|
getAcquisitionEndTime()
Returns the time when the activity finished generating assist data to build the AssistStructure. |
long
|
getAcquisitionStartTime()
Returns the time when the activity started generating assist data to build the AssistStructure. |
ComponentName
|
getActivityComponent()
Return the activity this AssistStructure came from. |
AssistStructure.WindowNode
|
getWindowNodeAt(int index)
Return one of the windows in the assist data. |
int
|
getWindowNodeCount()
Return the number of window contents that have been collected in this assist data. |
boolean
|
isHomeActivity()
Returns whether the activity associated with this AssistStructure was the home activity (Launcher) at the time the assist data was acquired. |
void
|
writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
Fields
Public constructors
Public methods
describeContents
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 |
getAcquisitionEndTime
public long getAcquisitionEndTime ()
Returns the time when the activity finished generating assist data to build the
AssistStructure. The time is as specified by SystemClock.uptimeMillis()
.
Returns | |
---|---|
long |
Returns the acquisition end time of the assist data, in milliseconds. |
See also:
getAcquisitionStartTime
public long getAcquisitionStartTime ()
Returns the time when the activity started generating assist data to build the
AssistStructure. The time is as specified by SystemClock.uptimeMillis()
.
Returns | |
---|---|
long |
Returns the acquisition start time of the assist data, in milliseconds. |
See also:
getActivityComponent
public ComponentName getActivityComponent ()
Return the activity this AssistStructure came from.
Returns | |
---|---|
ComponentName |
getWindowNodeAt
public AssistStructure.WindowNode getWindowNodeAt (int index)
Return one of the windows in the assist data.
Parameters | |
---|---|
index |
int : Which window to retrieve, may be 0 to getWindowNodeCount() -1. |
Returns | |
---|---|
AssistStructure.WindowNode |
getWindowNodeCount
public int getWindowNodeCount ()
Return the number of window contents that have been collected in this assist data.
Returns | |
---|---|
int |
isHomeActivity
public boolean isHomeActivity ()
Returns whether the activity associated with this AssistStructure was the home activity (Launcher) at the time the assist data was acquired.
Returns | |
---|---|
boolean |
Whether the activity was the home activity. |
See also:
writeToParcel
public void writeToParcel (Parcel out, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
out |
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 |