Skip to content

Most visited

Recently visited

navigation

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 onProvideAssistData(Bundle), onProvideStructure(ViewStructure), or onProvideVirtualStructure(ViewStructure).

The structure is used for autofill purposes when created by onProvideAutofillStructure(ViewStructure, int), or 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

From interface android.os.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
From interface android.os.Parcelable

Fields

CREATOR

added in API level 23
Creator<AssistStructure> CREATOR

Public constructors

AssistStructure

added in API level 23
AssistStructure ()

Public methods

describeContents

added in API level 23
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
long getAcquisitionEndTime ()

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

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

See also:

getAcquisitionStartTime

added in API level 26
long getAcquisitionStartTime ()

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

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

See also:

getActivityComponent

added in API level 23
ComponentName getActivityComponent ()

Return the activity this AssistStructure came from.

Returns
ComponentName

getWindowNodeAt

added in API level 23
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
int getWindowNodeCount ()

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

Returns
int

isHomeActivity

added in API level 26
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

added in API level 23
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_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)