RemoteInput

Class Overview

A RemoteInput object specifies input to be collected from a user to be passed along with an intent inside a PendingIntent that is sent. Always use RemoteInput.Builder to create instances of this class.

See Receiving Voice Input from a Notification for more information on how to use this class.

The following example adds a RemoteInput to a Notification.Action , sets the result key as quick_reply , and sets the label as Quick reply . Users are prompted to input a response when they trigger the action. The results are sent along with the intent and can be retrieved with the result key (provided to the RemoteInput.Builder constructor) from the Bundle returned by getResultsFromIntent(Intent) .

        public static final String KEY_QUICK_REPLY_TEXT = "quick_reply";
 Notification.Action action = new Notification.Action.Builder(
         R.drawable.reply, "Reply", actionIntent)
        
         .addRemoteInput(new RemoteInput.Builder(KEY_QUICK_REPLY_TEXT)
                 .setLabel("Quick reply").build()
        
        )
         .build();
       

When the PendingIntent is fired, the intent inside will contain the input results if collected. To access these results, use the getResultsFromIntent(Intent) function. The result values will present under the result key passed to the RemoteInput.Builder constructor.

        public static final String KEY_QUICK_REPLY_TEXT = "quick_reply";
 Bundle results = RemoteInput.getResultsFromIntent(intent);
 if (results != null) {
     CharSequence quickReplyResult = results.getCharSequence(KEY_QUICK_REPLY_TEXT);
 }
       

Summary

[Expand] Inherited Constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Bit masks for use with describeContents() : each bit represents a kind of object considered to have potential special significance when marshalled. 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) ".

[Expand] Inherited Methods
From class java.lang.Object Object clone () Creates and returns a copy of this Object . boolean equals ( Object o) Compares this instance with the specified object and indicates if they are equal. void finalize () Invoked when the garbage collector has detected that this instance is no longer reachable. final Class <?> getClass () Returns the unique instance of Class that represents this object's class. int hashCode () Returns an integer hash code for this object. final void notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. final void notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. String toString () Returns a string containing a concise, human-readable description of this object. final void wait () Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object. final void wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires. final void wait (long millis) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
From interface android.os.Parcelable abstract int describeContents () Describe the kinds of special objects contained in this Parcelable's marshalled representation. abstract void writeToParcel ( Parcel dest, int flags) Flatten this object in to a Parcel.