RemoteAction
  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 | 
|---|
| 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 | |
|---|---|
Fields
Public constructors
RemoteAction
public RemoteAction (Icon icon, CharSequence title, CharSequence contentDescription, PendingIntent intent)
| Parameters | |
|---|---|
| icon | Icon: This value cannot benull. | 
| title | CharSequence: This value cannot benull. | 
| contentDescription | CharSequence: This value cannot benull. | 
| intent | PendingIntent: This value cannot benull. | 
Public methods
clone
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:
 
will be true, and that the expression:
will be
true, but these are not absolute requirements.
 While it is typically the case that:
 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
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 0orCONTENTS_FILE_DESCRIPTOR | 
dump
public void dump (String prefix, PrintWriter pw)
| Parameters | |
|---|---|
| prefix | String | 
| pw | PrintWriter | 
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 | trueif this object is the same as the obj
          argument;falseotherwise. | 
getActionIntent
public PendingIntent getActionIntent ()
Return the action intent.
| Returns | |
|---|---|
| PendingIntent | This value cannot be null. | 
getContentDescription
public CharSequence getContentDescription ()
Return a content description representing the action.
| Returns | |
|---|---|
| CharSequence | This value cannot be null. | 
getIcon
public Icon getIcon ()
Return an icon representing the action.
| Returns | |
|---|---|
| Icon | This value cannot be null. | 
getTitle
public CharSequence getTitle ()
Return an title representing the action.
| Returns | |
|---|---|
| CharSequence | This value cannot be null. | 
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. | 
isEnabled
public boolean isEnabled ()
Return whether this action is enabled.
| Returns | |
|---|---|
| boolean | |
setEnabled
public void setEnabled (boolean enabled)
Sets whether this action is enabled.
| Parameters | |
|---|---|
| enabled | boolean | 
setShouldShowIcon
public void setShouldShowIcon (boolean shouldShowIcon)
Sets whether the icon should be shown.
| Parameters | |
|---|---|
| shouldShowIcon | boolean | 
shouldShowIcon
public boolean shouldShowIcon ()
Return whether the icon should be shown.
| Returns | |
|---|---|
| boolean | |
writeToParcel
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 benull. | 
| flags | int: Additional flags about how the object should be written.
 May be 0 orParcelable.PARCELABLE_WRITE_RETURN_VALUE.
 Value is either0or a combination ofParcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | 
