Added in API level 26

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

RemoteAction

Kotlin |Java

public final class RemoteAction
extends Object implements Parcelable

java.lang.Object
↳	android.app.RemoteAction

Represents a remote action that can be called from another process. The action can have an associated visualization including metadata like an icon or title.

Summary

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<RemoteAction>`	`CREATOR`

Public constructors
`RemoteAction(Icon icon, CharSequence title, CharSequence contentDescription, PendingIntent intent)`

Public methods
`RemoteAction`	`clone()` Creates and returns a copy of this object.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`void`	`dump(String prefix, PrintWriter pw)`
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`PendingIntent`	`getActionIntent()` Return the action intent.
`CharSequence`	`getContentDescription()` Return a content description representing the action.
`Icon`	`getIcon()` Return an icon representing the action.
`CharSequence`	`getTitle()` Return an title representing the action.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isEnabled()` Return whether this action is enabled.
`void`	`setEnabled(boolean enabled)` Sets whether this action is enabled.
`void`	`setShouldShowIcon(boolean shouldShowIcon)` Sets whether the icon should be shown.
`boolean`	`shouldShowIcon()` Return whether the icon should be shown.
`void`	`writeToParcel(Parcel out, 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 API level 26

public static final Creator<RemoteAction> CREATOR

Public constructors

RemoteAction

Added in API level 26

public RemoteAction (Icon icon, 
                CharSequence title, 
                CharSequence contentDescription, 
                PendingIntent intent)

Parameters
`icon`	`Icon`: This value cannot be `null`.
`title`	`CharSequence`: This value cannot be `null`.
`contentDescription`	`CharSequence`: This value cannot be `null`.
`intent`	`PendingIntent`: This value cannot be `null`.

Public methods

clone

Added in API level 26

public RemoteAction clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns
`RemoteAction`	a clone of this instance.

describeContents

Added in API level 26

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(android.os.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`

dump

Added in API level 26

public void dump (String prefix, 
                PrintWriter pw)

Parameters
`prefix`	`String`
`pw`	`PrintWriter`

equals

Added in API level 26

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 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
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getActionIntent

Added in API level 26

public PendingIntent getActionIntent ()

Return the action intent.

Returns
`PendingIntent`	This value cannot be `null`.

getContentDescription

Added in API level 26

public CharSequence getContentDescription ()

Return a content description representing the action.

Returns
`CharSequence`	This value cannot be `null`.

getIcon

Added in API level 26

public Icon getIcon ()

Return an icon representing the action.

Returns
`Icon`	This value cannot be `null`.

getTitle

Added in API level 26

public CharSequence getTitle ()

Return an title representing the action.

Returns
`CharSequence`	This value cannot be `null`.

hashCode

Added in API level 26

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 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.

Returns
`int`	a hash code value for this object.

isEnabled

Added in API level 26

public boolean isEnabled ()

Return whether this action is enabled.

Returns
`boolean`

setEnabled

Added in API level 26

public void setEnabled (boolean enabled)

Sets whether this action is enabled.

Parameters
`enabled`	`boolean`

setShouldShowIcon

Added in API level 28

public void setShouldShowIcon (boolean shouldShowIcon)

Sets whether the icon should be shown.

Parameters
`shouldShowIcon`	`boolean`

shouldShowIcon

Added in API level 28

public boolean shouldShowIcon ()

Return whether the icon should be shown.

Returns
`boolean`

writeToParcel

Added in API level 26

public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`out`	`Parcel`: The Parcel in which the object should be written. 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 `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES