Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.
added in version 1.0.0
belongs to Maven artifact androidx.core:core:1.1.0-alpha01

NotificationCompat.CarExtender

public static final class NotificationCompat.CarExtender
extends Object implements NotificationCompat.Extender

java.lang.Object
   ↳ 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 NotificationCompat.CarExtender.
  3. Set car-specific properties using the add and set methods of NotificationCompat.CarExtender.
  4. Call 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

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 notification)

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.

Inherited methods

Public constructors

NotificationCompat.CarExtender

added in version 1.0.0
public NotificationCompat.CarExtender ()

Create a NotificationCompat.CarExtender with default options.

NotificationCompat.CarExtender

added in version 1.0.0
public NotificationCompat.CarExtender (Notification notification)

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

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

Public methods

extend

added in version 1.0.0
public NotificationCompat.Builder extend (NotificationCompat.Builder builder)

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

Parameters
builder NotificationCompat.Builder: the builder to be modified.

Returns
NotificationCompat.Builder the build object for chaining.

getColor

added in version 1.0.0
public int getColor ()

Gets the accent color.

Returns
int

See also:

getLargeIcon

added in version 1.0.0
public Bitmap getLargeIcon ()

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

Returns
Bitmap The large icon for the car notification.

getUnreadConversation

added in version 1.0.0
public NotificationCompat.CarExtender.UnreadConversation getUnreadConversation ()

Returns the unread conversation conveyed by this notification.

Returns
NotificationCompat.CarExtender.UnreadConversation

setColor

added in version 1.0.0
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 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.

Parameters
color int

Returns
NotificationCompat.CarExtender

setLargeIcon

added in version 1.0.0
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 NotificationCompat.Builder.setLargeIcon(android.graphics.Bitmap)

Parameters
largeIcon Bitmap: The large icon to use in the car notification.

Returns
NotificationCompat.CarExtender This object for method chaining.

setUnreadConversation

added in version 1.0.0
public NotificationCompat.CarExtender setUnreadConversation (NotificationCompat.CarExtender.UnreadConversation unreadConversation)

Sets the unread conversation in a message notification.

Parameters
unreadConversation NotificationCompat.CarExtender.UnreadConversation: The unread part of the conversation this notification conveys.

Returns
NotificationCompat.CarExtender This object for method chaining.