CarAppExtender.Builder

public static final class CarAppExtender.Builder
extends Object

java.lang.Object
   ↳ androidx.car.app.notification.CarAppExtender.Builder


A builder of CarAppExtender.

Summary

Public constructors

Builder()

Creates an empty CarAppExtender.Builder instance.

Public methods

CarAppExtender.Builder addAction(int icon, CharSequence title, PendingIntent intent)

Adds an action to this notification.

CarAppExtender build()

Constructs the CarAppExtender defined by this builder.

CarAppExtender.Builder setChannelId(String channelId)

For Android Automotive OS only, sets the channel id of the notification channel to be used in the car.

CarAppExtender.Builder setColor(CarColor color)

Sets the background color of the notification in the car screen.

CarAppExtender.Builder setContentIntent(PendingIntent contentIntent)

Supplies a PendingIntent to send when the notification is clicked in the car.

CarAppExtender.Builder setContentText(CharSequence contentText)

Sets the content text of the notification in the car screen.

CarAppExtender.Builder setContentTitle(CharSequence contentTitle)

Sets the title of the notification in the car screen.

CarAppExtender.Builder setDeleteIntent(PendingIntent deleteIntent)

Supplies a PendingIntent to send when the user clears the notification by either using the "clear all" functionality in the notification center, or tapping the individual "close" buttons on the notification in the car screen.

CarAppExtender.Builder setImportance(int importance)

For Android Auto only, sets the importance of the notification in the car screen.

CarAppExtender.Builder setLargeIcon(Bitmap bitmap)

Sets the large icon of the notification in the car screen.

CarAppExtender.Builder setSmallIcon(int iconResId)

Sets the small icon of the notification in the car screen.

Inherited methods

Public constructors

Builder

public Builder ()

Creates an empty CarAppExtender.Builder instance.

Public methods

addAction

public CarAppExtender.Builder addAction (int icon, 
                CharSequence title, 
                PendingIntent intent)

Adds an action to this notification.

Actions are typically displayed by the system as a button adjacent to the notification content.

A notification may offer up to 2 actions. The system may not display some actions in the compact notification UI (e.g. heads-up-notifications).

If one or more action is added with this method, any action added by NotificationCompat.Builder.addAction(int, CharSequence, PendingIntent) will be ignored.

This method is equivalent to NotificationCompat.Builder.addAction(int, CharSequence, PendingIntent) for the car screen.

Parameters
icon int: resource ID of a drawable that represents the action. In order to display the actions properly, a valid resource id for the icon must be provided

title CharSequence: text describing the action

intent PendingIntent: PendingIntent to send when the action is invoked. In the case of navigation notifications in the rail widget, this intent will be sent when the user taps on the action icon in the rail widget

Returns
CarAppExtender.Builder

Throws
NullPointerException if title or intent are null

build

public CarAppExtender build ()

Constructs the CarAppExtender defined by this builder.

Returns
CarAppExtender

setChannelId

public CarAppExtender.Builder setChannelId (String channelId)

For Android Automotive OS only, sets the channel id of the notification channel to be used in the car.

This is used in the case where your notification is to have a different importance in the car then it does on the phone.

It is used for the same purposes you'd use setImportance(int) for Auto.

Parameters