Added in API level 37.2

VisualizerViewAction

class VisualizerViewAction : Parcelable
kotlin.Any
   ↳ 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 or by directly attaching the intent generated from createIntent to a view using RemoteViews.setOnClickResponse.

Summary

Nested classes

Builder for creating VisualizerViewAction instances.
Inherited constants
Public methods
static Unit
attach(context: Context, remoteViews: RemoteViews, viewId: Int, onClickAction: VisualizerViewAction?, onLongClickAction: VisualizerViewAction?)

Attaches the specified short-click and/or long-click actions to the target view inside a RemoteViews hierarchy.
static Intent
createIntent(onClickAction: VisualizerViewAction?, onLongClickAction: VisualizerViewAction?)

Converts the specified actions into an Intent intended for use with RemoteViews.setOnClickPendingIntent(int,PendingIntent).
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
ContextInsight?

Returns the ContextInsight configured to report an attribution event when triggered, or null if this action does not perform attribution.
ContextInsight?

Returns the ContextInsight configured to be egressed to the client app when triggered, or null if this action does not perform egress.
FeedbackRequest?

Returns the FeedbackRequest configured to be provided to the feedback activity when triggered, or null if this action does not perform feedback.
Int

Returns a hash code value for the object.
Boolean

Returns whether triggering this action will end the visualization session, causing the visualization to stop displaying.
String

Returns a string representation of the object.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<VisualizerViewAction!>

Public methods

attach

Added in API level 37.2
static fun attach(
    context: Context, 
    remoteViews: RemoteViews, 
    viewId: Int, 
    onClickAction: VisualizerViewAction?, 
    onLongClickAction: VisualizerViewAction?
): Unit

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.
Exceptions
java.lang.IllegalArgumentException if both onClickAction and onLongClickAction are null.

createIntent

Added in API level 37.2
static fun createIntent(
    onClickAction: VisualizerViewAction?, 
    onLongClickAction: VisualizerViewAction?
): Intent

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.
Return
Intent An Intent containing the actions parceled as extras.
This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if both onClickAction and onLongClickAction are null.

describeContents

Added in API level 37.2
fun describeContents(): Int

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.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 37.2
fun equals(other: Any?): Boolean

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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

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
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAttributionInsight

Added in API level 37.2
fun getAttributionInsight(): ContextInsight?

Returns the ContextInsight configured to report an attribution event when triggered, or null if this action does not perform attribution.

getEgressInsight

Added in API level 37.2
fun getEgressInsight(): ContextInsight?

Returns the ContextInsight configured to be egressed to the client app when triggered, or null if this action does not perform egress.

getFeedbackRequest

Added in API level 37.2
fun getFeedbackRequest(): FeedbackRequest?

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 android.service.personalcontext.PersonalContextManager#EXTRA_FEEDBACK_REQUEST.

hashCode

Added in API level 37.2
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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 hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 equals method, then calling the hashCode method 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 equals method, then calling the hashCode method 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.
Return
Int a hash code value for this object.

shouldCloseSessionOnTriggered

Added in API level 37.2
fun shouldCloseSessionOnTriggered(): Boolean

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.

toString

Added in API level 37.2
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 37.2
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:

Properties

CREATOR

Added in API level 37.2
static val CREATOR: Parcelable.Creator<VisualizerViewAction!>