Summary: Ctors | Methods | Inherited Methods

NotificationCompat.Action.Builder

Kotlin |Java

public static final class NotificationCompat.Action.Builder
extends Object

java.lang.Object
↳	androidx.core.app.NotificationCompat.Action.Builder

---

Builder class for NotificationCompat.Action objects.

Summary

Public constructors
Builder(IconCompat icon, CharSequence title, PendingIntent intent) Construct a new builder for NotificationCompat.Action object.
Builder(int icon, CharSequence title, PendingIntent intent) Construct a new builder for NotificationCompat.Action object.
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 RemoteInput.getChoices().
NotificationCompat.Action.Builder	setContextual(boolean isContextual) Sets whether this NotificationCompat.Action is a contextual action, i.e.
NotificationCompat.Action.Builder	setSemanticAction(int semanticAction) Sets the NotificationCompat.Action.SemanticAction for this NotificationCompat.Action.
NotificationCompat.Action.Builder	setShowsUserInterface(boolean showsUserInterface) Set whether or not this NotificationCompat.Action's PendingIntent will open a user interface.

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public constructors

Builder

public Builder (IconCompat icon, 
                CharSequence title, 
                PendingIntent intent)

Construct a new builder for NotificationCompat.Action object.

Note: For devices running an Android version strictly lower than API level 23 this constructor only supports resource-ID based IconCompat objects.

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

Builder

public 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

Builder

public 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

public 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:

• NotificationCompat.Action.getExtras()

addRemoteInput

public 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 RemoteInput.getResultsFromIntent(Intent) function.

Parameters
remoteInput	RemoteInput: a RemoteInput to add to the action

Returns
NotificationCompat.Action.Builder	this object for method chaining

build

public 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

Throws
NullPointerException	if this is a contextual Action and its Intent is null.

extend

public 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

public Bundle getExtras ()

Get the metadata Bundle used by this Builder.

The returned Bundle is shared with this Builder.

Returns
Bundle

setAllowGeneratedReplies

public NotificationCompat.Action.Builder setAllowGeneratedReplies (boolean allowGeneratedReplies)

Set whether the platform should automatically generate possible replies to add to RemoteInput.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 true

setContextual

public NotificationCompat.Action.Builder setContextual (boolean isContextual)

Sets whether this NotificationCompat.Action is a contextual action, i.e. whether the action is dependent on the notification message body. An example of a contextual action could be an action opening a map application with an address shown in the notification.

Parameters
isContextual	boolean

Returns
NotificationCompat.Action.Builder

setSemanticAction

public NotificationCompat.Action.Builder setSemanticAction (int semanticAction)

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

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

Returns
NotificationCompat.Action.Builder	this object for method chaining

setShowsUserInterface

public NotificationCompat.Action.Builder setShowsUserInterface (boolean showsUserInterface)

Set whether or not this NotificationCompat.Action's PendingIntent will open a user interface.

Parameters
showsUserInterface	boolean: true if this NotificationCompat.Action's PendingIntent will open a user interface, otherwise false

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