Notification.Action.Builder

Builder

public Builder (Notification.Action action)

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

Builder

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

Construct a new builder for Action object.

As of Android Build.VERSION_CODES.S, apps targeting API level Build.VERSION_CODES.S or higher won't be able to start activities while processing broadcast receivers or services in response to notification action clicks. To launch an activity in those cases, provide a PendingIntent for the activity itself.

How an Action is displayed, including whether the icon, text, or both are displayed or required, depends on where and how the action is used, and the Style applied to the Notification.

As of Android Build.VERSION_CODES.N, action button icons will not be displayed on action buttons, but are still required and are available to notification listeners, which may display them in other contexts, for example on a wearable device.

When the title is a Spanned, any colors set by a ForegroundColorSpan or TextAppearanceSpan may be removed or displayed with an altered in luminance to ensure proper contrast within the Notification.

Builder

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

Construct a new builder for Action object.

As of Android Build.VERSION_CODES.N, action button icons will not be displayed on action buttons, but are still required and are available to notification listeners, which may display them in other contexts, for example on a wearable device.

addExtras

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.

addRemoteInput

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

build

public Notification.Action build ()

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

extend

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.

getExtras

public Bundle getExtras ()

Get the metadata Bundle used by this Builder.

The returned Bundle is shared with this Builder.

setAllowGeneratedReplies

public Notification.Action.Builder setAllowGeneratedReplies (boolean allowGeneratedReplies)

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.

setAuthenticationRequired

public Notification.Action.Builder setAuthenticationRequired (boolean authenticationRequired)

Sets whether the OS should only send this action's PendingIntent on an unlocked device. If this is true and the device is locked when the action is invoked, the OS will show the keyguard and require successful authentication before invoking the intent. If this is false and the device is locked, the OS will decide whether authentication should be required.

setContextual

public Notification.Action.Builder setContextual (boolean isContextual)

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

public Notification.Action.Builder setSemanticAction (int semanticAction)

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