Added in API level 23

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

AssistContent

---

Kotlin |Java

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 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<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 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<AssistContent> CREATOR

Public constructors

AssistContent

Added in API level 23

public AssistContent ()

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

getClipData

Added in API level 23

public ClipData getClipData ()

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

Returns
ClipData

getExtras

Added in API level 23

public Bundle getExtras ()

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

Returns
Bundle

getIntent

Added in API level 23

public 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

public String getStructuredData ()

Returns the current setStructuredData(String).

Returns
String

getWebUri

Added in API level 23

public 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

public 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

public 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

public 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 Intent#FLAG_GRANT_READ_URI_PERMISSION.

Parameters
clip	ClipData

setIntent

Added in API level 23

public 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 Intent#FLAG_GRANT_READ_URI_PERMISSION so the accessibility service can access it.

Parameters
intent	Intent

setStructuredData

Added in API level 23

public 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

public 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 Intent#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

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