CarExtender

class CarExtender : NotificationCompat.Extender
kotlin.Any
   ↳ androidx.core.app.NotificationCompat.CarExtender

Helper class to add Android Auto extensions to notifications. To create a notification with car extensions:

  1. Create an NotificationCompat.Builder, setting any desired properties.
  2. Create a CarExtender.
  3. Set car-specific properties using the add and set methods of CarExtender.
  4. Call androidx.core.app.NotificationCompat.Builder#extend(NotificationCompat.Extender) to apply the extensions to a notification.
  5. Post the notification to the notification system with the NotificationManagerCompat.notify(...) methods and not the NotificationManager.notify(...) methods.
 Notification notification = new NotificationCompat.Builder(context) ... .extend(new CarExtender() .set*(...)) .build(); 

Car extensions can be accessed on an existing notification by using the CarExtender(Notification) constructor, and then using the get methods to access values.

Summary

Nested classes

A class which holds the unread messages from a conversation.

Public constructors

Create a CarExtender with default options.

<init>(notification: Notification!)

Create a CarExtender from the CarExtender options of an existing Notification.

Public methods
NotificationCompat.CarExtender!
setColor(color: Int)

Sets the accent color to use when Android Auto presents the notification.

Int

Gets the accent color.

NotificationCompat.CarExtender!

Sets the unread conversation in a message notification.

NotificationCompat.CarExtender.UnreadConversation!

Returns the unread conversation conveyed by this notification.

NotificationCompat.Builder!

Apply car extensions to a notification that is being built.

NotificationCompat.CarExtender!
setLargeIcon(largeIcon: Bitmap!)

Sets the large icon of the car notification.

Bitmap!

Gets the large icon used in this car notification, or null if no icon has been set.

Public constructors

<init>

CarExtender()

Create a CarExtender with default options.

<init>

CarExtender(notification: Notification!)

Create a CarExtender from the CarExtender options of an existing Notification.

Parameters
notification Notification!: The notification from which to copy options.

Public methods

setColor

fun setColor(color: Int): NotificationCompat.CarExtender!

Sets the accent color to use when Android Auto presents the notification. Android Auto uses the color set with androidx.core.app.NotificationCompat.Builder#setColor(int) to accent the displayed notification. However, not all colors are acceptable in an automotive setting. This method can be used to override the color provided in the notification in such a situation.

getColor

fun getColor(): Int

Gets the accent color.

See Also

setUnreadConversation

fun setUnreadConversation(unreadConversation: NotificationCompat.CarExtender.UnreadConversation!): NotificationCompat.CarExtender!

Sets the unread conversation in a message notification.

Parameters
unreadConversation NotificationCompat.CarExtender.UnreadConversation!: The unread part of the conversation this notification conveys.
Return
NotificationCompat.CarExtender!: This object for method chaining.

getUnreadConversation

fun getUnreadConversation(): NotificationCompat.CarExtender.UnreadConversation!

Returns the unread conversation conveyed by this notification.

extend

fun extend(builder: NotificationCompat.Builder!): NotificationCompat.Builder!

Apply car extensions to a notification that is being built. This is typically called by the androidx.core.app.NotificationCompat.Builder#extend(NotificationCompat.Extender) method of NotificationCompat.Builder.

Parameters
builder NotificationCompat.Builder!: the builder to be modified.
Return
NotificationCompat.Builder!: the build object for chaining.

setLargeIcon

fun setLargeIcon(largeIcon: Bitmap!): NotificationCompat.CarExtender!

Sets the large icon of the car notification. If no large icon is set in the extender, Android Auto will display the icon specified by androidx.core.app.NotificationCompat.Builder#setLargeIcon(android.graphics.Bitmap)

Parameters
largeIcon Bitmap!: The large icon to use in the car notification.
Return
NotificationCompat.CarExtender!: This object for method chaining.

getLargeIcon

fun getLargeIcon(): Bitmap!

Gets the large icon used in this car notification, or null if no icon has been set.

Return
Bitmap!: The large icon for the car notification.