AssistStructure

public class AssistStructure
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.assist.AssistStructure


Assist data automatically created by 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 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 be available just for assist or autofill purposes; in those case, the property availability will be document in its javadoc.

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

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

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.

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.

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.

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.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.