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
.
Inherited constants |
---|
![]() 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 |
Bundle |
getExtras() Return Bundle for extra vendor-specific data that can be modified and examined. |
Intent |
getIntent() Returns the current |
String |
getStructuredData() Returns the current |
Uri |
getWebUri() Return the content's web URI as per |
boolean |
isAppProvidedIntent() Returns whether or not the current Intent was explicitly provided in |
boolean |
isAppProvidedWebUri() Returns whether or not the current |
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 |
|
---|---|
![]() java.lang.Object
|
|
![]() android.os.Parcelable
|
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. |
ClipData getClipData ()
Return the current setClipData(ClipData)
, which you can modify in-place.
Returns | |
---|---|
ClipData |
Bundle getExtras ()
Return Bundle for extra vendor-specific data that can be modified and examined.
Returns | |
---|---|
Bundle |
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 |
String getStructuredData ()
Returns the current setStructuredData(String)
.
Returns | |
---|---|
String |
Uri getWebUri ()
Return the content's web URI as per setWebUri(android.net.Uri)
, or null if there is none.
Returns | |
---|---|
Uri |
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 |
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 |
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
|
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
|
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
|
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
|
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 . |