Added in version 37.2

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

VisualizerViewAction

Kotlin |Java

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 `VisualizerViewAction` instances.

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<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 `RemoteViews` hierarchy.
`static Intent`	`createIntent(VisualizerViewAction onClickAction, VisualizerViewAction onLongClickAction)` Converts the specified actions into an `Intent` intended for use with `RemoteViews.setOnClickPendingIntent(int,PendingIntent)`.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`ContextInsight`	`getAttributionInsight()` Returns the `ContextInsight` configured to report an attribution event when triggered, or null if this action does not perform attribution.
`ContextInsight`	`getEgressInsight()` Returns the `ContextInsight` configured to be egressed to the client app when triggered, or null if this action does not perform egress.
`FeedbackRequest`	`getFeedbackRequest()` Returns the `FeedbackRequest` configured to be provided to the feedback activity when triggered, or null if this action does not perform feedback.
`boolean`	`shouldCloseSessionOnTriggered()` Returns whether triggering this action will end the visualization session, causing the visualization to stop displaying.
`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 version 37.2

public static final Creator<VisualizerViewAction> CREATOR

Public methods

Added in version 37.2

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

Added in version 37.2

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

Added in version 37.2

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 `CONTENTS_FILE_DESCRIPTOR`

getAttributionInsight

Added in version 37.2

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

Added in version 37.2

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

Added in version 37.2

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`

See also:

Builder.setFeedbackRequest(FeedbackRequest)

shouldCloseSessionOnTriggered

Added in version 37.2

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`

See also:

Builder.setShouldCloseSessionOnTriggered(boolean)

writeToParcel

Added in version 37.2

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: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`

VisualizerViewAction

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

attach

createIntent

describeContents

getAttributionInsight

getEgressInsight

getFeedbackRequest

shouldCloseSessionOnTriggered

writeToParcel