Added in API level 23

Summary: Nested Classes | Ctors | Methods | Inherited Methods

Notification.CarExtender

Kotlin |Java

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

java.lang.Object
↳	android.app.Notification.CarExtender

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

Create an Notification.Builder, setting any desired properties.
Create a CarExtender.
Set car-specific properties using the add and set methods of CarExtender.
Call 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.

Summary

Nested classes
`class`	`Notification.CarExtender.Builder` Builder class for `CarExtender.UnreadConversation` objects.
`class`	`Notification.CarExtender.UnreadConversation` A class which holds the unread messages from a conversation.

Public constructors
`CarExtender()` Create a `CarExtender` with default options.
`CarExtender(Notification notif)` Create a `CarExtender` from the CarExtender options of an existing Notification.

Public methods
`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.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.app.Notification.Extender


        abstract
        
        
        
        
        Notification.Builder


      extend(Notification.Builder builder)

Apply this extender to a notification builder.

Public constructors

CarExtender

Added in API level 23

public CarExtender ()

Create a CarExtender with default options.

CarExtender

Added in API level 23

public CarExtender (Notification notif)

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

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

Public methods

extend

Added in API level 23

public Notification.Builder extend (Notification.Builder builder)

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

Parameters
`builder`	`Notification.Builder`: the builder to be modified.

Returns
`Notification.Builder`	the build object for chaining.

getColor

Added in API level 23

public int getColor ()

Gets the accent color.

Returns
`int`

See also:

setColor(int)

getLargeIcon

Added in API level 23

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.

See also:

setLargeIcon(Bitmap)

getUnreadConversation

Added in API level 23

public Notification.CarExtender.UnreadConversation getUnreadConversation ()

Returns the unread conversation conveyed by this notification.

Returns
`Notification.CarExtender.UnreadConversation`

See also:

setUnreadConversation(UnreadConversation)

setColor

Added in API level 23

public Notification.CarExtender setColor (int color)

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

Parameters
`color`	`int`

Returns
`Notification.CarExtender`

setLargeIcon

Added in API level 23

public Notification.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 Notification.Builder#setLargeIcon(android.graphics.Bitmap)

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

Returns
`Notification.CarExtender`	This object for method chaining.

setUnreadConversation

Added in API level 23

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

Sets the unread conversation in a message notification.

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

Returns
`Notification.CarExtender`	This object for method chaining.

Notification.CarExtender

Summary

Nested classes

Public constructors

Public methods

Inherited methods

Public constructors

CarExtender

CarExtender

Public methods

extend

getColor

getLargeIcon

getUnreadConversation

setColor

setLargeIcon

setUnreadConversation