Skip to content

Most visited

Recently visited

navigation

AssistContent

public class AssistContent
extends Object implements Parcelable

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


Holds information about the content an application is viewing, to hand to an assistant at the user's request. This is filled in by Activity.onProvideAssistContent.

Summary

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<AssistContent> CREATOR

Public constructors

AssistContent()

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

ClipData getClipData()

Return the current setClipData(ClipData), which you can modify in-place.

Bundle getExtras()

Return Bundle for extra vendor-specific data that can be modified and examined.

Intent getIntent()

Returns the current setIntent(Intent) if one is set, else the default Intent obtained from Activity.getIntent.

String getStructuredData()

Returns the current setStructuredData(String).

Uri getWebUri()

Return the content's web URI as per setWebUri(android.net.Uri), or null if there is none.

boolean isAppProvidedIntent()

Returns whether or not the current Intent was explicitly provided in Activity.onProvideAssistContent.

boolean isAppProvidedWebUri()

Returns whether or not the current getWebUri() was explicitly provided in Activity.onProvideAssistContent.

void setClipData(ClipData clip)

Optional additional content items that are involved with the current UI.

void setIntent(Intent intent)

Sets the Intent associated with the content, describing the current top-level context of the activity.

void setStructuredData(String structuredData)

Sets optional structured data regarding the content being viewed.

void setWebUri(Uri uri)

Set a web URI associated with the current data being shown to the user.

void writeToParcel(Parcel dest, 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<AssistContent> CREATOR

Public constructors

AssistContent

added in API level 23
AssistContent ()

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.

getClipData

added in API level 23
ClipData getClipData ()

Return the current setClipData(ClipData), which you can modify in-place.

Returns
ClipData

getExtras

added in API level 23
Bundle getExtras ()

Return Bundle for extra vendor-specific data that can be modified and examined.

Returns
Bundle

getIntent

added in API level 23
Intent getIntent ()

Returns the current setIntent(Intent) if one is set, else the default Intent obtained from Activity.getIntent. Can be modified in-place.

Returns
Intent

getStructuredData

added in API level 23
String getStructuredData ()

Returns the current setStructuredData(String).

Returns
String

getWebUri

added in API level 23
Uri getWebUri ()

Return the content's web URI as per setWebUri(android.net.Uri), or null if there is none.

Returns
Uri

isAppProvidedIntent

added in API level 23
boolean isAppProvidedIntent ()

Returns whether or not the current Intent was explicitly provided in Activity.onProvideAssistContent. If not, the Intent was automatically set based on Activity.getIntent.

Returns
boolean

isAppProvidedWebUri

added in API level 24
boolean isAppProvidedWebUri ()

Returns whether or not the current getWebUri() was explicitly provided in Activity.onProvideAssistContent. If not, the Intent was automatically set based on Activity.getIntent.

Returns
boolean

setClipData

added in API level 23
void setClipData (ClipData clip)

Optional additional content items that are involved with the current UI. Access to this content will be granted to the assistant as if you are sending it through an Intent with FLAG_GRANT_READ_URI_PERMISSION.

Parameters
clip ClipData

setIntent

added in API level 23
void setIntent (Intent intent)

Sets the Intent associated with the content, describing the current top-level context of the activity. If this contains a reference to a piece of data related to the activity, be sure to set FLAG_GRANT_READ_URI_PERMISSION so the accessibility service can access it.

Parameters
intent Intent

setStructuredData

added in API level 23
void setStructuredData (String structuredData)

Sets optional structured data regarding the content being viewed. The provided data must be a string represented with JSON-LD using the schema.org vocabulary.

Parameters
structuredData String

setWebUri

added in API level 23
void setWebUri (Uri uri)

Set a web URI associated with the current data being shown to the user. This URI could be opened in a web browser, or in the app as an ACTION_VIEW Intent, to show the same data that is currently being displayed by it. The URI here should be something that is transportable off the device into other environments to acesss the same data as is currently being shown in the app; if the app does not have such a representation, it should leave the null and only report the local intent and clip data.

Parameters
uri Uri

writeToParcel

added in API level 23
void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest 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 one-minute survey?
Help us improve Android tools and documentation.