public static final class Notification.CarExtender extends Object implements Notification.Extender
Helper class to add Android Auto extensions to notifications. To create a notification with car extensions:
Notification.Builder
, setting any desired
properties.
Notification.CarExtender
.
add
and set
methods of
Notification.CarExtender
.
Notification.Builder.extend(Notification.Extender)
to apply the extensions to a notification.
Notification notification = new Notification.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.
Modifier and Type | Class and Description |
---|---|
static class |
Notification.CarExtender.Builder
Builder class for
Notification.CarExtender.UnreadConversation objects. |
static class |
Notification.CarExtender.UnreadConversation
A class which holds the unread messages from a conversation.
|
Constructor and Description |
---|
CarExtender()
Create a
Notification.CarExtender with default options. |
CarExtender(Notification notif)
Create a
Notification.CarExtender from the CarExtender options of an existing Notification. |
Modifier and Type | Method and Description |
---|---|
Notification.Builder |
extend(Notification.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.
|
Notification.CarExtender.UnreadConversation |
getUnreadConversation()
Returns the unread conversation conveyed by this notification.
|
Notification.CarExtender |
setColor(int color)
Sets the accent color to use when Android Auto presents the notification.
|
Notification.CarExtender |
setLargeIcon(Bitmap largeIcon)
Sets the large icon of the car notification.
|
Notification.CarExtender |
setUnreadConversation(Notification.CarExtender.UnreadConversation unreadConversation)
Sets the unread conversation in a message notification.
|
public CarExtender()
Notification.CarExtender
with default options.public CarExtender(Notification notif)
Notification.CarExtender
from the CarExtender options of an existing Notification.notif
- The notification from which to copy options.public Notification.Builder extend(Notification.Builder builder)
Notification.Builder.extend(Notification.Extender)
method of Notification.Builder
.extend
in interface Notification.Extender
builder
- the builder to be modified.public Notification.CarExtender setColor(int color)
Notification.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.public int getColor()
setColor(int)
public Notification.CarExtender setLargeIcon(Bitmap largeIcon)
Notification.Builder.setLargeIcon(android.graphics.Bitmap)
largeIcon
- The large icon to use in the car notification.public Bitmap getLargeIcon()
setLargeIcon(android.graphics.Bitmap)
public Notification.CarExtender setUnreadConversation(Notification.CarExtender.UnreadConversation unreadConversation)
unreadConversation
- The unread part of the conversation this notification conveys.public Notification.CarExtender.UnreadConversation getUnreadConversation()