Most visited

Recently visited

NotificationCompat.Action.Builder

public static final class NotificationCompat.Action.Builder
extends Object

java.lang.Object
   ↳ android.support.v4.app.NotificationCompat.Action.Builder


Builder class for NotificationCompat.Action objects.

Summary

Public constructors

NotificationCompat.Action.Builder(int icon, CharSequence title, PendingIntent intent)

Construct a new builder for NotificationCompat.Action object.

NotificationCompat.Action.Builder(NotificationCompat.Action action)

Construct a new builder for NotificationCompat.Action object using the fields from an NotificationCompat.Action.

Public methods

NotificationCompat.Action.Builder addExtras(Bundle extras)

Merge additional metadata into this builder.

NotificationCompat.Action.Builder addRemoteInput(RemoteInput remoteInput)

Add an input to be collected from the user when this action is sent.

NotificationCompat.Action build()

Combine all of the options that have been set and return a new NotificationCompat.Action object.

NotificationCompat.Action.Builder extend(NotificationCompat.Action.Extender extender)

Apply an extender to this action builder.

Bundle getExtras()

Get the metadata Bundle used by this Builder.

NotificationCompat.Action.Builder setAllowGeneratedReplies(boolean allowGeneratedReplies)

Set whether the platform should automatically generate possible replies to add to getChoices().

Inherited methods

From class java.lang.Object

Public constructors

NotificationCompat.Action.Builder

NotificationCompat.Action.Builder (int icon, 
                CharSequence title, 
                PendingIntent intent)

Construct a new builder for NotificationCompat.Action object.

Parameters
icon int: icon to show for this action
title CharSequence: the title of the action
intent PendingIntent: the PendingIntent to fire when users trigger this action

NotificationCompat.Action.Builder

NotificationCompat.Action.Builder (NotificationCompat.Action action)

Construct a new builder for NotificationCompat.Action object using the fields from an NotificationCompat.Action.

Parameters
action NotificationCompat.Action: the action to read fields from.

Public methods

addExtras

NotificationCompat.Action.Builder addExtras (Bundle extras)

Merge additional metadata into this builder.

Values within the Bundle will replace existing extras values in this Builder.

Parameters
extras Bundle
Returns
NotificationCompat.Action.Builder

See also:

addRemoteInput

NotificationCompat.Action.Builder addRemoteInput (RemoteInput remoteInput)

Add an input to be collected from the user when this action is sent. Response values can be retrieved from the fired intent by using the getResultsFromIntent(Intent) function.

Parameters
remoteInput RemoteInput: a RemoteInput to add to the action
Returns
NotificationCompat.Action.Builder this object for method chaining

build

NotificationCompat.Action build ()

Combine all of the options that have been set and return a new NotificationCompat.Action object.

Returns
NotificationCompat.Action the built action

extend

NotificationCompat.Action.Builder extend (NotificationCompat.Action.Extender extender)

Apply an extender to this action builder. Extenders may be used to add metadata or change options on this builder.

Parameters
extender NotificationCompat.Action.Extender
Returns
NotificationCompat.Action.Builder

getExtras

Bundle getExtras ()

Get the metadata Bundle used by this Builder.

The returned Bundle is shared with this Builder.

Returns
Bundle

setAllowGeneratedReplies

NotificationCompat.Action.Builder setAllowGeneratedReplies (boolean allowGeneratedReplies)

Set whether the platform should automatically generate possible replies to add to getChoices(). If the NotificationCompat.Action doesn't have a RemoteInput, this has no effect.

Parameters
allowGeneratedReplies boolean: true to allow generated replies, false otherwise
Returns
NotificationCompat.Action.Builder this object for method chaining The default value is false

Hooray!