Added in API level 23

AssistStructure

---

Kotlin |Java

open class AssistStructure : Parcelable

kotlin.Any
↳	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 android.app.Activity#onProvideAssistData, 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
open	ViewNode Describes a single view in the assist data.
open	WindowNode Describes a window in the assist data.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
AssistStructure()

Public methods
open Int	describeContents()
open Long	getAcquisitionEndTime() Returns the time when the activity finished generating assist data to build the AssistStructure.
open Long	getAcquisitionStartTime() Returns the time when the activity started generating assist data to build the AssistStructure.
open ComponentName!	getActivityComponent() Return the activity this AssistStructure came from.
open AssistStructure.WindowNode!	getWindowNodeAt(index: Int) Return one of the windows in the assist data.
open Int	getWindowNodeCount() Return the number of window contents that have been collected in this assist data.
open Boolean	isHomeActivity() Returns whether the activity associated with this AssistStructure was the home activity (Launcher) at the time the assist data was acquired.
open Unit	writeToParcel(out: Parcel, flags: Int)

Properties
static Parcelable.Creator<AssistStructure!>	CREATOR

Public constructors

AssistStructure

Added in API level 23

AssistStructure()

Public methods

describeContents

Added in API level 23

open fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getAcquisitionEndTime

Added in API level 26

open fun getAcquisitionEndTime(): Long

Returns the time when the activity finished generating assist data to build the AssistStructure. The time is as specified by SystemClock.uptimeMillis().

Return
Long	Returns the acquisition end time of the assist data, in milliseconds.

See Also

• #getAcquisitionStartTime()

getAcquisitionStartTime

Added in API level 26

open fun getAcquisitionStartTime(): Long

Returns the time when the activity started generating assist data to build the AssistStructure. The time is as specified by SystemClock.uptimeMillis().

Return
Long	Returns the acquisition start time of the assist data, in milliseconds.

See Also

• #getAcquisitionEndTime()

getActivityComponent

Added in API level 23

open fun getActivityComponent(): ComponentName!

Return the activity this AssistStructure came from.

getWindowNodeAt

Added in API level 23

open fun getWindowNodeAt(index: Int): AssistStructure.WindowNode!

Return one of the windows in the assist data.

Parameters
index	Int: Which window to retrieve, may be 0 to getWindowNodeCount()-1.

getWindowNodeCount

Added in API level 23

open fun getWindowNodeCount(): Int

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

isHomeActivity

Added in API level 26

open fun isHomeActivity(): Boolean

Returns whether the activity associated with this AssistStructure was the home activity (Launcher) at the time the assist data was acquired.

Return
Boolean	Whether the activity was the home activity.

See Also

• android.content.Intent#CATEGORY_HOME

writeToParcel

Added in API level 23

open fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit

Parameters
dest	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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 23

static val CREATOR: Parcelable.Creator<AssistStructure!>