Notification.Action.Builder

public static final class Notification.Action.Builder
extends Object

java.lang.Object
   ↳ android.app.Notification.Action.Builder


Builder class for Notification.Action objects.

Summary

Public constructors

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

Construct a new builder for Notification.Action object.

Notification.Action.Builder(Icon icon, CharSequence title, PendingIntent intent)

Construct a new builder for Notification.Action object.

Notification.Action.Builder(Notification.Action action)

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

Public methods

Notification.Action.Builder addExtras(Bundle extras)

Merge additional metadata into this builder.

Notification.Action.Builder addRemoteInput(RemoteInput remoteInput)

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

Notification.Action build()

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

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

Apply an extender to this action builder.

Bundle getExtras()

Get the metadata Bundle used by this Builder.

Notification.Action.Builder setAllowGeneratedReplies(boolean allowGeneratedReplies)

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

Notification.Action.Builder setSemanticAction(int semanticAction)

Sets the SemanticAction for this Notification.Action.

Inherited methods

Public constructors

Notification.Action.Builder

added in API level 20
public Notification.Action.Builder (int icon, 
                CharSequence title, 
                PendingIntent intent)

Construct a new builder for Notification.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

Notification.Action.Builder

added in API level 23
public Notification.Action.Builder (Icon icon, 
                CharSequence title, 
                PendingIntent intent)

Construct a new builder for Notification.Action object.

Parameters
icon Icon: icon to show for this action

title CharSequence: the title of the action

intent PendingIntent: the PendingIntent to fire when users trigger this action

Notification.Action.Builder

added in API level 20
public Notification.Action.Builder (Notification.Action action)

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

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

Public methods

addExtras

added in API level 20
public Notification.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
Notification.Action.Builder

addRemoteInput

added in API level 20
public Notification.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 RemoteInput.getResultsFromIntent(Intent) function.

Parameters
remoteInput RemoteInput: a RemoteInput to add to the action

Returns
Notification.Action.Builder this object for method chaining

build

added in API level 20
public Notification.Action build ()

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

Returns
Notification.Action the built action

extend

added in API level 20
public Notification.Action.Builder extend (Notification.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 Notification.Action.Extender

Returns
Notification.Action.Builder

getExtras

added in API level 20
public Bundle getExtras ()

Get the metadata Bundle used by this Builder.

The returned Bundle is shared with this Builder.

Returns
Bundle

setAllowGeneratedReplies

added in API level 24
public Notification.Action.Builder setAllowGeneratedReplies (boolean allowGeneratedReplies)

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

Parameters
allowGeneratedReplies boolean: true to allow generated replies, false otherwise

Returns
Notification.Action.Builder this object for method chaining The default value is true

setSemanticAction

added in API level 28
public Notification.Action.Builder setSemanticAction (int semanticAction)

Sets the SemanticAction for this Notification.Action. A SemanticAction denotes what an Notification.Action's PendingIntent will do (eg. reply, mark as read, delete, etc).

Parameters
semanticAction int: a SemanticAction defined within Notification.Action with SEMANTIC_ACTION_ prefixes

Value is SEMANTIC_ACTION_NONE, SEMANTIC_ACTION_REPLY, SEMANTIC_ACTION_MARK_AS_READ, SEMANTIC_ACTION_MARK_AS_UNREAD, SEMANTIC_ACTION_DELETE, SEMANTIC_ACTION_ARCHIVE, SEMANTIC_ACTION_MUTE, SEMANTIC_ACTION_UNMUTE, SEMANTIC_ACTION_THUMBS_UP, SEMANTIC_ACTION_THUMBS_DOWN or SEMANTIC_ACTION_CALL.

Returns
Notification.Action.Builder this object for method chaining