WearableExtender

Kotlin |Java

class WearableExtender : NotificationCompat.Extender

kotlin.Any
↳	androidx.core.app.NotificationCompat.WearableExtender

Helper class to add wearable extensions to notifications.

See Creating Notifications for Android Wear for more information on how to use this class.

To create a notification with wearable extensions:

Create a NotificationCompat.Builder, setting any desired properties.
Create a NotificationCompat.WearableExtender.
Set wearable-specific properties using the add and set methods of NotificationCompat.WearableExtender.
Call NotificationCompat.Builder#extend to apply the extensions to a notification.
Post the notification to the notification system with the NotificationManagerCompat.notify(...) methods and not the NotificationManager.notify(...) methods.

Notification notification = new NotificationCompat.Builder(mContext)
              .setContentTitle("New mail from " + sender.toString())
              .setContentText(subject)
              .setSmallIcon(R.drawable.new_mail)
              .extend(new NotificationCompat.WearableExtender()
                      .setContentIcon(R.drawable.new_mail))
              .build();
      NotificationManagerCompat.from(mContext).notify(0, notification);

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

NotificationCompat.WearableExtender wearableExtender =
              new NotificationCompat.WearableExtender(notification);
      List<Notification> pages = wearableExtender.getPages();

Summary

Constants
static Int	`SCREEN_TIMEOUT_LONG` Sentinel value for use with `setHintScreenTimeout` to keep the screen on for a longer amount of time when this notification is displayed on the screen.
static Int	`SCREEN_TIMEOUT_SHORT` Sentinel value for use with `setHintScreenTimeout` to keep the screen on for a short amount of time when this notification is displayed on the screen.
static Int	`SIZE_DEFAULT` Size value for use with `setCustomSizePreset` to show this notification with default sizing.
static Int	`SIZE_FULL_SCREEN` Size value for use with `setCustomSizePreset` to show this notification full screen.
static Int	`SIZE_LARGE` Size value for use with `setCustomSizePreset` to show this notification with a large size.
static Int	`SIZE_MEDIUM` Size value for use with `setCustomSizePreset` to show this notification with a medium size.
static Int	`SIZE_SMALL` Size value for use with `setCustomSizePreset` to show this notification with a small size.
static Int	`SIZE_XSMALL` Size value for use with `setCustomSizePreset` to show this notification with an extra small size.
static Int	`UNSET_ACTION_INDEX` Sentinel value for an action index that is unset.

Public constructors
`<init>()` Create a `NotificationCompat.WearableExtender` with default options.
`<init>(@NonNull notification: Notification)`

Public methods
NotificationCompat.WearableExtender	`addAction(@NonNull action: NotificationCompat.Action)` Add a wearable action to this notification.
NotificationCompat.WearableExtender	`addActions(@NonNull actions: MutableList<NotificationCompat.Action!>)` Adds wearable actions to this notification.
NotificationCompat.WearableExtender	`addPage(@NonNull page: Notification)` Add an additional page of content to display with this notification.
NotificationCompat.WearableExtender	`addPages(@NonNull pages: MutableList<Notification!>)` Add additional pages of content to display with this notification.
NotificationCompat.WearableExtender	`clearActions()` Clear all wearable actions present on this builder.
NotificationCompat.WearableExtender	`clearPages()` Clear all additional pages present on this builder.
NotificationCompat.WearableExtender	`clone()`
NotificationCompat.Builder	`extend(@NonNull builder: NotificationCompat.Builder)` Apply wearable extensions to a notification that is being built.
MutableList<NotificationCompat.Action!>	`getActions()` Get the wearable actions present on this notification.
Bitmap?	`getBackground()` Get a background image to be displayed behind the notification content.
String?	`getBridgeTag()` Returns the bridge tag of the notification.
Int	`getContentAction()` Get the index of the notification action, if any, that was specified as the primary action.
Int	`getContentIcon()` Get an icon that goes with the content of this notification.
Int	`getContentIconGravity()` Get the gravity that the content icon should have within the notification display.
Boolean	`getContentIntentAvailableOffline()` Get whether the content intent is available when the wearable device is not connected to a companion device.
Int	`getCustomContentHeight()` Get the custom height in pixels for the display of this notification's content.
Int	`getCustomSizePreset()` Get the custom size preset for the display of this notification out of the available presets found in `NotificationCompat.WearableExtender`, e.
String?	`getDismissalId()` Returns the dismissal id of the notification.
PendingIntent?	`getDisplayIntent()` Get the intent to launch inside of an activity view when displaying this notification.
Int	`getGravity()` Get the gravity that this notification should have within the available viewport space.
Boolean	`getHintAmbientBigPicture()` Get a hint that this notification's `BigPictureStyle` (if present) should be converted to low-bit and displayed in ambient mode, especially useful for barcodes and qr codes, as well as other simple black-and-white tickets.
Boolean	`getHintAvoidBackgroundClipping()` Get a hint that this notification's background should not be clipped if possible, and should instead be resized to fully display on the screen, retaining the aspect ratio of the image.
Boolean	`getHintContentIntentLaunchesActivity()` Get a hint that this notification's content intent will launch an `Activity` directly, telling the platform that it can generate the appropriate transitions
Boolean	`getHintHideIcon()` Get a hint that this notification's icon should not be displayed.
Int	`getHintScreenTimeout()` Get the duration, in milliseconds, that the screen should remain on for when this notification is displayed.
Boolean	`getHintShowBackgroundOnly()` Get a visual hint that only the background image of this notification should be displayed, and other semantic content should be hidden.