InsightActionDetails


class InsightActionDetails : Parcelable
kotlin.Any
   ↳ android.app.personalcontext.insight.InsightActionDetails

Contains the details of an action to be performed, either as an PendingIntent or a RemoteAction. Note that multiple actions can be specified, in which case it is up to the receiver to decide which action to perform. Use hasActionType to determine if a particular action type has been specified. It is guaranteed that there will be at least one action type.

Summary

Nested classes

Builder for InsightActionDetails.

Constants
static Int

The action details contain a RemoteAppFunctionAction.

static Int

The action details contain an PendingIntent.

static Int

The action details contain a RemoteAction.

static Int

The action details contain a RemoteAppFunctionAction.

static Int

The action details contain an PendingIntent.

static Int

The action details contain a RemoteAction.

Inherited constants
Public methods
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.

Int

Returns the action types contained in this action details.

PendingIntent?

Returns the PendingIntent these details contain, or null if there is no PendingIntent.

RemoteAction?

Returns the RemoteAction these details contain, or null if there is no remote action.

RemoteAppFunctionAction?

Returns the RemoteAppFunctionAction these details contain, or null if there is no RemoteAppFunctionAction.

Boolean
hasActionType(actionType: Int)

Returns whether the action details has the given action type.

Int

Returns a hash code value for the object.

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<InsightActionDetails!>

Constants

ACTION_HAS_APP_FUNCTION

static val ACTION_HAS_APP_FUNCTION: Int

The action details contain a RemoteAppFunctionAction.

Value: 4

ACTION_HAS_PENDING_INTENT

static val ACTION_HAS_PENDING_INTENT: Int

The action details contain an PendingIntent.

Value: 1

ACTION_HAS_REMOTE_ACTION

static val ACTION_HAS_REMOTE_ACTION: Int

The action details contain a RemoteAction.

Value: 2

ACTION_TYPE_APP_FUNCTION

Added in API level 37.2
Deprecated in API level 37.2
static val ACTION_TYPE_APP_FUNCTION: Int

Deprecated: use ACTION_HAS_APP_FUNCTION

The action details contain a RemoteAppFunctionAction.

Value: 4

ACTION_TYPE_PENDING_INTENT

Added in API level 37.2
Deprecated in API level 37.2
static val ACTION_TYPE_PENDING_INTENT: Int

Deprecated: use ACTION_HAS_PENDING_INTENT

The action details contain an PendingIntent.

Value: 1

ACTION_TYPE_REMOTE_ACTION

Added in API level 37.2
Deprecated in API level 37.2
static val ACTION_TYPE_REMOTE_ACTION: Int

Deprecated: use ACTION_HAS_REMOTE_ACTION

The action details contain a RemoteAction.

Value: 2

Public methods

describeContents

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

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.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getActionTypes

fun getActionTypes(): Int

Returns the action types contained in this action details.

Return
Int Value is either 0 or a combination of the following:

getPendingIntent

fun getPendingIntent(): PendingIntent?

Returns the PendingIntent these details contain, or null if there is no PendingIntent.

getRemoteAction

fun getRemoteAction(): RemoteAction?

Returns the RemoteAction these details contain, or null if there is no remote action.

getRemoteAppFunctionAction

fun getRemoteAppFunctionAction(): RemoteAppFunctionAction?

Returns the RemoteAppFunctionAction these details contain, or null if there is no RemoteAppFunctionAction.

hasActionType

fun hasActionType(actionType: Int): Boolean

Returns whether the action details has the given action type.

Parameters
actionType Int: Value is either 0 or a combination of the following:

hashCode

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.

toString

fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags Int: Value is either 0 or a combination of the following:

Properties

CREATOR

static val CREATOR: Parcelable.Creator<InsightActionDetails!>