Added in API level 23

Summary: Nested Classes | Inherited Constants | Fields | Ctors | Methods | Inherited Methods

AssistStructure

---

Kotlin |Java

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

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

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
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(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(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() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 23

public static final Creator<AssistStructure> CREATOR

Public constructors

AssistStructure

Added in API level 23

public AssistStructure ()

Public methods

describeContents

Added in API level 23

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

Added in API level 26

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()

getAcquisitionStartTime

Added in API level 26

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:

• getAcquisitionEndTime()

getActivityComponent

Added in API level 23

public ComponentName getActivityComponent ()

Return the activity this AssistStructure came from.

Returns
ComponentName

getWindowNodeAt

Added in API level 23

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

Added in API level 23

public int getWindowNodeCount ()

Return the number of window contents that have been collected in this assist data.

Returns
int

isHomeActivity

Added in API level 26

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:

• Intent.CATEGORY_HOME

writeToParcel

Added in API level 23

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