NotificationCompat.WearableExtender

const val SCREEN_TIMEOUT_LONG = -1: Int

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.

const val SCREEN_TIMEOUT_SHORT = 0: Int

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. This is the default value.

const val SIZE_DEFAULT = 0: Int

Size value for use with setCustomSizePreset to show this notification with default sizing.

For custom display notifications created using setDisplayIntent, the default is SIZE_MEDIUM. All other notifications size automatically based on their content.

const val SIZE_FULL_SCREEN = 5: Int

Size value for use with setCustomSizePreset to show this notification full screen.

This value is only applicable for custom display notifications created using setDisplayIntent.

const val SIZE_LARGE = 4: Int

Size value for use with setCustomSizePreset to show this notification with a large size.

This value is only applicable for custom display notifications created using setDisplayIntent.

const val SIZE_MEDIUM = 3: Int

Size value for use with setCustomSizePreset to show this notification with a medium size.

This value is only applicable for custom display notifications created using setDisplayIntent.

const val SIZE_SMALL = 2: Int

Size value for use with setCustomSizePreset to show this notification with a small size.

This value is only applicable for custom display notifications created using setDisplayIntent.

const val SIZE_XSMALL = 1: Int

Size value for use with setCustomSizePreset to show this notification with an extra small size.

This value is only applicable for custom display notifications created using setDisplayIntent.

const val UNSET_ACTION_INDEX = -1: Int

Sentinel value for an action index that is unset.

WearableExtender()

Create a NotificationCompat.WearableExtender with default options.

fun addAction(action: NotificationCompat.Action): NotificationCompat.WearableExtender

Add a wearable action to this notification.

When wearable actions are added using this method, the set of actions that show on a wearable device splits from devices that only show actions added using addAction. This allows for customization of which actions display on different devices.

fun addActions(actions: (Mutable)List<NotificationCompat.Action!>): NotificationCompat.WearableExtender

Adds wearable actions to this notification.

When wearable actions are added using this method, the set of actions that show on a wearable device splits from devices that only show actions added using addAction. This allows for customization of which actions display on different devices.

fun addPage(page: Notification): NotificationCompat.WearableExtender

Add an additional page of content to display with this notification. The current notification forms the first page, and pages added using this function form subsequent pages. This field can be used to separate a notification into multiple sections.

fun addPages(pages: (Mutable)List<Notification!>): NotificationCompat.WearableExtender

Add additional pages of content to display with this notification. The current notification forms the first page, and pages added using this function form subsequent pages. This field can be used to separate a notification into multiple sections.

fun clearActions(): NotificationCompat.WearableExtender

Clear all wearable actions present on this builder.

fun clearPages(): NotificationCompat.WearableExtender

Clear all additional pages present on this builder.

fun extend(builder: NotificationCompat.Builder): NotificationCompat.Builder

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

fun getActions(): (Mutable)List<NotificationCompat.Action!>

Get the wearable actions present on this notification.

fun getBackground(): Bitmap?

Get a background image to be displayed behind the notification content. Contrary to the NotificationCompat.BigPictureStyle, this background will work with any notification style.

fun getBridgeTag(): String?

Returns the bridge tag of the notification.

fun getContentAction(): Int

Get the index of the notification action, if any, that was specified as the primary action.

If wearable specific actions were added to the main notification, this index will apply to that list, otherwise it will apply to the regular actions list.

fun getContentIcon(): Int

Get an icon that goes with the content of this notification.

fun getContentIconGravity(): Int

Get the gravity that the content icon should have within the notification display. Supported values include START and END. The default value is END.

fun getContentIntentAvailableOffline(): Boolean

Get whether the content intent is available when the wearable device is not connected to a companion device. The user can still trigger this intent when the wearable device is offline, but a visual hint will indicate that the content intent may not be available. Defaults to true.

fun getCustomContentHeight(): Int

Get the custom height in pixels for the display of this notification's content.

This option is only available for custom display notifications created using setDisplayIntent. See also setCustomSizePreset and setCustomContentHeight.

fun getCustomSizePreset(): Int

Get the custom size preset for the display of this notification out of the available presets found in NotificationCompat.WearableExtender, e.g. SIZE_LARGE.

Some custom size presets are only applicable for custom display notifications created using setDisplayIntent. Check the documentation for the preset in question. See also setCustomContentHeight and setCustomSizePreset.

fun getDismissalId(): String?

Returns the dismissal id of the notification.

fun getDisplayIntent(): PendingIntent?

Get the intent to launch inside of an activity view when displaying this notification. This PendingIntent should be for an activity.

fun getGravity(): Int

Get the gravity that this notification should have within the available viewport space. Supported values include TOP, CENTER_VERTICAL and BOTTOM. The default value is BOTTOM.

fun getHintAmbientBigPicture(): Boolean

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.

fun getHintAvoidBackgroundClipping(): Boolean

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. This can be useful for images like barcodes or qr codes.

fun getHintContentIntentLaunchesActivity(): Boolean

Get a hint that this notification's content intent will launch an Activity directly, telling the platform that it can generate the appropriate transitions

fun getHintHideIcon(): Boolean

Get a hint that this notification's icon should not be displayed.

fun getHintScreenTimeout(): Int

Get the duration, in milliseconds, that the screen should remain on for when this notification is displayed.

fun getHintShowBackgroundOnly(): Boolean

Get a visual hint that only the background image of this notification should be displayed, and other semantic content should be hidden. This hint is only applicable to sub-pages added using addPage.

fun getPages(): (Mutable)List<Notification!>

Get the array of additional pages of content for displaying this notification. The current notification forms the first page, and elements within this array form subsequent pages. This field can be used to separate a notification into multiple sections.

fun getStartScrollBottom(): Boolean

Get whether the scrolling position for the contents of this notification should start at the bottom of the contents instead of the top when the contents are too long to display within the screen. Default is false (start scroll at the top).

fun setBackground(background: Bitmap?): NotificationCompat.WearableExtender

Set a background image to be displayed behind the notification content. Contrary to the NotificationCompat.BigPictureStyle, this background will work with any notification style.

fun setBridgeTag(bridgeTag: String?): NotificationCompat.WearableExtender

Sets a bridge tag for this notification. A bridge tag can be set for notifications posted from a phone to provide finer-grained control on what notifications are bridged to wearables. See Adding Wearable Features to Notifications for more information.

fun setContentAction(actionIndex: Int): NotificationCompat.WearableExtender

Set an action from this notification's actions as the primary action. If the action has a RemoteInput associated with it, shortcuts to the options for that input are shown directly on the notification.

fun setContentIcon(icon: Int): NotificationCompat.WearableExtender

Set an icon that goes with the content of this notification.

fun setContentIconGravity(contentIconGravity: Int): NotificationCompat.WearableExtender

Set the gravity that the content icon should have within the notification display. Supported values include START and END. The default value is END.

fun setContentIntentAvailableOffline(
    contentIntentAvailableOffline: Boolean
): NotificationCompat.WearableExtender

Set whether the content intent is available when the wearable device is not connected to a companion device. The user can still trigger this intent when the wearable device is offline, but a visual hint will indicate that the content intent may not be available. Defaults to true.

fun setCustomContentHeight(height: Int): NotificationCompat.WearableExtender

Set the custom height in pixels for the display of this notification's content.

This option is only available for custom display notifications created using setDisplayIntent. See also setCustomSizePreset and getCustomContentHeight.

fun setCustomSizePreset(sizePreset: Int): NotificationCompat.WearableExtender

Set the custom size preset for the display of this notification out of the available presets found in NotificationCompat.WearableExtender, e.g. SIZE_LARGE.

Some custom size presets are only applicable for custom display notifications created using setDisplayIntent. Check the documentation for the preset in question. See also setCustomContentHeight and getCustomSizePreset.

fun setDismissalId(dismissalId: String?): NotificationCompat.WearableExtender

Sets the dismissal id for this notification. If a notification is posted with a dismissal id, then when that notification is canceled, notifications on other wearables and the paired Android phone having that same dismissal id will also be canceled. See Adding Wearable Features to Notifications for more information.

fun setDisplayIntent(intent: PendingIntent?): NotificationCompat.WearableExtender

Set an intent to launch inside of an activity view when displaying this notification. The PendingIntent provided should be for an activity.

Intent displayIntent = new Intent(context, MyDisplayActivity.class);
PendingIntent displayPendingIntent = PendingIntent.getActivity(context,
        0, displayIntent, PendingIntent.FLAG_UPDATE_CURRENT);
Notification notification = new NotificationCompat.Builder(context)
        .extend(new NotificationCompat.WearableExtender()
                .setDisplayIntent(displayPendingIntent)
                .setCustomSizePreset(NotificationCompat.WearableExtender.SIZE_MEDIUM))
.build();

The activity to launch needs to allow embedding, must be exported, and should have an empty task affinity. It is also recommended to use the device default light theme.

Example AndroidManifest.xml entry:

<activity android:name="com.example.MyDisplayActivity"
    android:exported="true"
    android:allowEmbedded="true"
    android:taskAffinity=""
android:theme="@android:style/Theme.DeviceDefault.Light" />

fun setGravity(gravity: Int): NotificationCompat.WearableExtender

Set the gravity that this notification should have within the available viewport space. Supported values include TOP, CENTER_VERTICAL and BOTTOM. The default value is BOTTOM.

fun setHintAmbientBigPicture(hintAmbientBigPicture: Boolean): NotificationCompat.WearableExtender

Set 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.

fun setHintAvoidBackgroundClipping(hintAvoidBackgroundClipping: Boolean): NotificationCompat.WearableExtender

Set 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. This can be useful for images like barcodes or qr codes.

fun setHintContentIntentLaunchesActivity(
    hintContentIntentLaunchesActivity: Boolean
): NotificationCompat.WearableExtender

Set a hint that this notification's content intent will launch an Activity directly, telling the platform that it can generate the appropriate transitions.

fun setHintHideIcon(hintHideIcon: Boolean): NotificationCompat.WearableExtender

Set a hint that this notification's icon should not be displayed.

fun setHintScreenTimeout(timeout: Int): NotificationCompat.WearableExtender

Set a hint that the screen should remain on for at least this duration when this notification is displayed on the screen.

fun setHintShowBackgroundOnly(hintShowBackgroundOnly: Boolean): NotificationCompat.WearableExtender

Set a visual hint that only the background image of this notification should be displayed, and other semantic content should be hidden. This hint is only applicable to sub-pages added using addPage.

fun setStartScrollBottom(startScrollBottom: Boolean): NotificationCompat.WearableExtender

Set whether the scrolling position for the contents of this notification should start at the bottom of the contents instead of the top when the contents are too long to display within the screen. Default is false (start scroll at the top).