Android APIs
public static final class

NotificationCompat.CarExtender

extends Object
implements NotificationCompat.Extender
java.lang.Object
   ↳ android.support.v4.app.NotificationCompat.CarExtender

Class Overview

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 NotificationCompat.CarExtender.
  3. Set car-specific properties using the add and set methods of NotificationCompat.CarExtender.
  4. Call 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
class NotificationCompat.CarExtender.UnreadConversation A class which holds the unread messages from a conversation. 
Public Constructors
NotificationCompat.CarExtender()
Create a NotificationCompat.CarExtender with default options.
NotificationCompat.CarExtender(Notification notif)
Create a NotificationCompat.CarExtender from the CarExtender options of an existing Notification.
Public Methods
NotificationCompat.Builder extend(NotificationCompat.Builder builder)
Apply car extensions to a notification that is being built.
int getColor()
Gets the accent color.
Bitmap getLargeIcon()
Gets the large icon used in this car notification, or null if no icon has been set.
NotificationCompat.CarExtender.UnreadConversation getUnreadConversation()
Returns the unread conversation conveyed by this notification.
NotificationCompat.CarExtender setColor(int color)
Sets the accent color to use when Android Auto presents the notification.
NotificationCompat.CarExtender setLargeIcon(Bitmap largeIcon)
Sets the large icon of the car notification.
NotificationCompat.CarExtender setUnreadConversation(NotificationCompat.CarExtender.UnreadConversation unreadConversation)
Sets the unread conversation in a message notification.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.support.v4.app.NotificationCompat.Extender

Public Constructors

public NotificationCompat.CarExtender ()

Create a NotificationCompat.CarExtender with default options.

public NotificationCompat.CarExtender (Notification notif)

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

Parameters
notif The notification from which to copy options.

Public Methods

public NotificationCompat.Builder extend (NotificationCompat.Builder builder)

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

Parameters
builder the builder to be modified.
Returns
  • the build object for chaining.

public int getColor ()

Gets the accent color.

See Also

public Bitmap getLargeIcon ()

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

Returns
  • The large icon for the car notification.
See Also

public NotificationCompat.CarExtender.UnreadConversation getUnreadConversation ()

Returns the unread conversation conveyed by this notification.

See Also

public NotificationCompat.CarExtender setColor (int color)

Sets the accent color to use when Android Auto presents the notification. Android Auto uses the color set with 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.

public NotificationCompat.CarExtender setLargeIcon (Bitmap largeIcon)

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 setLargeIcon(android.graphics.Bitmap)

Parameters
largeIcon The large icon to use in the car notification.
Returns
  • This object for method chaining.

public NotificationCompat.CarExtender setUnreadConversation (NotificationCompat.CarExtender.UnreadConversation unreadConversation)

Sets the unread conversation in a message notification.

Parameters
unreadConversation The unread part of the conversation this notification conveys.
Returns
  • This object for method chaining.