VisualizerViewAction
public
final
class
VisualizerViewAction
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.service.personalcontext.embedded.VisualizerViewAction |
Class representing interactive actions attached to a view in a visualization generated in InsightVisualizerSession.createRemoteViewsForHints.
Visualizers wanting to add interactivity to the RemoteViews they produced must use
this class. Multiple actions can be run on a single interaction using the Builder.
Actions can be attached to the UI with attach(Context, RemoteViews, int, VisualizerViewAction, VisualizerViewAction) or by directly attaching the intent
generated from createIntent(VisualizerViewAction, VisualizerViewAction) to a view using RemoteViews.setOnClickResponse.
Summary
Nested classes | |
|---|---|
class |
VisualizerViewAction.Builder
Builder for creating |
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<VisualizerViewAction> |
CREATOR
|
Public methods | |
|---|---|
static
void
|
attach(Context context, RemoteViews remoteViews, int viewId, VisualizerViewAction onClickAction, VisualizerViewAction onLongClickAction)
Attaches the specified short-click and/or long-click actions to the target view inside a
|
static
Intent
|
createIntent(VisualizerViewAction onClickAction, VisualizerViewAction onLongClickAction)
Converts the specified actions into an |
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
ContextInsight
|
getAttributionInsight()
Returns the |
ContextInsight
|
getEgressInsight()
Returns the |
FeedbackRequest
|
getFeedbackRequest()
Returns the |
int
|
hashCode()
Returns a hash code value for the object. |
boolean
|
shouldCloseSessionOnTriggered()
Returns whether triggering this action will end the visualization session, causing the visualization to stop displaying. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Fields
Public methods
attach
public static void attach (Context context, RemoteViews remoteViews, int viewId, VisualizerViewAction onClickAction, VisualizerViewAction onLongClickAction)
Attaches the specified short-click and/or long-click actions to the target view inside a
RemoteViews hierarchy.
| Parameters | |
|---|---|
context |
Context: The Context used to create the underlying PendingIntent.
This value cannot be null. |
remoteViews |
RemoteViews: The RemoteViews hierarchy containing the target view.
This value cannot be null. |
viewId |
int: The resource ID of the view that should trigger these actions when clicked. |
onClickAction |
VisualizerViewAction: The action to execute when the target view is clicked, or null if none. |
onLongClickAction |
VisualizerViewAction: The action to execute when the target view is long-pressed, or null
if none. |
| Throws | |
|---|---|
IllegalArgumentException |
if both onClickAction and onLongClickAction are null. |
createIntent
public static Intent createIntent (VisualizerViewAction onClickAction, VisualizerViewAction onLongClickAction)
Converts the specified actions into an Intent intended for use with RemoteViews.setOnClickPendingIntent(int,PendingIntent).
| Parameters | |
|---|---|
onClickAction |
VisualizerViewAction: The action to execute when the target view is clicked, or null if none. |
onLongClickAction |
VisualizerViewAction: The action to execute when the target view is long-pressed, or null
if none. |
| Returns | |
|---|---|
Intent |
An Intent containing the actions parceled as extras.
This value cannot be null. |
| Throws | |
|---|---|
IllegalArgumentException |
if both onClickAction and onLongClickAction are null. |
describeContents
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.
Value is either 0 or
|
equals
public boolean equals (Object o)
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation
on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
o |
Object: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getAttributionInsight
public ContextInsight getAttributionInsight ()
Returns the ContextInsight configured to report an attribution event when triggered,
or null if this action does not perform attribution.
| Returns | |
|---|---|
ContextInsight |
|
getEgressInsight
public ContextInsight getEgressInsight ()
Returns the ContextInsight configured to be egressed to the client app when
triggered, or null if this action does not perform egress.
| Returns | |
|---|---|
ContextInsight |
|
getFeedbackRequest
public FeedbackRequest getFeedbackRequest ()
Returns the FeedbackRequest configured to be provided to the feedback activity when
triggered, or null if this action does not perform feedback.
When the feedback activity is launched, this FeedbackRequest is delivered as a
Parcelable extra under ERROR(/android.service.personalcontext.PersonalContextManager#EXTRA_FEEDBACK_REQUEST).
| Returns | |
|---|---|
FeedbackRequest |
|
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Returns | |
|---|---|
int |
a hash code value for this object. |
shouldCloseSessionOnTriggered
public boolean shouldCloseSessionOnTriggered ()
Returns whether triggering this action will end the visualization session, causing the visualization to stop displaying.
The visualizer session will receive the InsightVisualizerSession.close(int)
callback when this action is triggered.
| Returns | |
|---|---|
boolean |
|
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String |
a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel: 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 the following:
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-09-16 UTC.