Builder

Kotlin |Java

class Builder

kotlin.Any
↳	androidx.core.app.NotificationCompat.Action.Builder

Builder class for Action objects.

Summary

Public constructors
<init>(@Nullable icon: IconCompat?, @Nullable title: CharSequence?, @Nullable intent: PendingIntent?) Construct a new builder for Action object.
<init>(icon: Int, @Nullable title: CharSequence?, @Nullable intent: PendingIntent?) Construct a new builder for Action object.
<init>(@NonNull action: NotificationCompat.Action) Construct a new builder for Action object using the fields from an Action.

Public methods
NotificationCompat.Action.Builder	addExtras(@Nullable extras: Bundle?) Merge additional metadata into this builder.
NotificationCompat.Action.Builder	addRemoteInput(@Nullable 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 Action object.
NotificationCompat.Action.Builder	extend(@NonNull extender: NotificationCompat.Action.Extender) Apply an extender to this action builder.
Bundle	getExtras() Get the metadata Bundle used by this Builder.
NotificationCompat.Action.Builder	setAllowGeneratedReplies(allowGeneratedReplies: Boolean) Set whether the platform should automatically generate possible replies to add to RemoteInput#getChoices().
NotificationCompat.Action.Builder	setContextual(isContextual: Boolean) Sets whether this Action is a contextual action, i.
NotificationCompat.Action.Builder	setSemanticAction(semanticAction: Int) Sets the SemanticAction for this Action.
NotificationCompat.Action.Builder	setShowsUserInterface(showsUserInterface: Boolean) Set whether or not this Action's PendingIntent will open a user interface.

Public constructors

<init>

Builder(
    @Nullable icon: IconCompat?, 
    @Nullable title: CharSequence?, 
    @Nullable intent: PendingIntent?)

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

<init>

Builder(
    icon: Int, 
    @Nullable title: CharSequence?, 
    @Nullable intent: PendingIntent?)

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

<init>

Builder(@NonNull action: NotificationCompat.Action)

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

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

Public methods

addExtras

@NonNull fun addExtras(@Nullable extras: Bundle?): NotificationCompat.Action.Builder

Merge additional metadata into this builder.

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

See Also

• NotificationCompat.Action#getExtras

addRemoteInput

@NonNull fun addRemoteInput(@Nullable remoteInput: RemoteInput?): NotificationCompat.Action.Builder

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 function.

Parameters
remoteInput	RemoteInput?: a RemoteInput to add to the action

Return
NotificationCompat.Action.Builder	this object for method chaining

build

@NonNull fun build(): NotificationCompat.Action

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

Return
NotificationCompat.Action	the built action

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

extend

@NonNull fun extend(@NonNull extender: NotificationCompat.Action.Extender): NotificationCompat.Action.Builder

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

getExtras

@NonNull fun getExtras(): Bundle

Get the metadata Bundle used by this Builder.

The returned Bundle is shared with this Builder.

setAllowGeneratedReplies

@NonNull fun setAllowGeneratedReplies(allowGeneratedReplies: Boolean): NotificationCompat.Action.Builder

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

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

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

setContextual

@NonNull fun setContextual(isContextual: Boolean): NotificationCompat.Action.Builder

Sets whether this 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.

setSemanticAction

@NonNull fun setSemanticAction(semanticAction: Int): NotificationCompat.Action.Builder

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

Parameters
semanticAction	Int: a SemanticAction defined within Action with SEMANTIC_ACTION_ prefixes

Return
NotificationCompat.Action.Builder	this object for method chaining

setShowsUserInterface

@NonNull fun setShowsUserInterface(showsUserInterface: Boolean): NotificationCompat.Action.Builder

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

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

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