NotificationCompat.WearableExtender

public static final int SCREEN_TIMEOUT_LONG = -1

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.

public static final int SCREEN_TIMEOUT_SHORT = 0

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.

public static final int SIZE_DEFAULT = 0

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.

public static final int SIZE_FULL_SCREEN = 5

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

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

public static final int SIZE_LARGE = 4

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.

public static final int SIZE_MEDIUM = 3

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.

public static final int SIZE_SMALL = 2

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.

public static final int SIZE_XSMALL = 1

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.

public static final int UNSET_ACTION_INDEX = -1

Sentinel value for an action index that is unset.

public WearableExtender()

Create a NotificationCompat.WearableExtender with default options.

public WearableExtender(@NonNull Notification notification)

public @NonNull NotificationCompat.WearableExtender addAction(@NonNull NotificationCompat.Action action)

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.

public @NonNull NotificationCompat.WearableExtender addActions(@NonNull List<NotificationCompat.Action> actions)

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.

public @NonNull NotificationCompat.WearableExtender addPage(@NonNull Notification page)

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.

public @NonNull NotificationCompat.WearableExtender addPages(@NonNull List<Notification> pages)

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.

public @NonNull NotificationCompat.WearableExtender clearActions()

Clear all wearable actions present on this builder.

public @NonNull NotificationCompat.WearableExtender clearPages()

Clear all additional pages present on this builder.

public @NonNull NotificationCompat.WearableExtender clone()

public @NonNull NotificationCompat.Builder extend(@NonNull NotificationCompat.Builder builder)

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

public @NonNull List<NotificationCompat.Action> getActions()

Get the wearable actions present on this notification.

public @Nullable Bitmap getBackground()

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

public @Nullable String getBridgeTag()

Returns the bridge tag of the notification.

public int getContentAction()

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.

public int getContentIcon()

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

public int getContentIconGravity()

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

public boolean getContentIntentAvailableOffline()

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.

public int getCustomContentHeight()

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.

public int getCustomSizePreset()

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.

public @Nullable String getDismissalId()

Returns the dismissal id of the notification.

public @Nullable PendingIntent getDisplayIntent()

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

public int getGravity()

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.

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

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

public 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

public boolean getHintHideIcon()

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

public int getHintScreenTimeout()

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

public boolean getHintShowBackgroundOnly()

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.

public @NonNull List<Notification> getPages()

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.

public boolean getStartScrollBottom()

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

public @NonNull NotificationCompat.WearableExtender setBackground(@Nullable Bitmap background)

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

public @NonNull NotificationCompat.WearableExtender setBridgeTag(@Nullable String bridgeTag)

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.

public @NonNull NotificationCompat.WearableExtender setContentAction(int actionIndex)

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.

public @NonNull NotificationCompat.WearableExtender setContentIcon(int icon)

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

public @NonNull NotificationCompat.WearableExtender setContentIconGravity(int contentIconGravity)

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

public @NonNull NotificationCompat.WearableExtender setContentIntentAvailableOffline(
    boolean contentIntentAvailableOffline
)

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.

public @NonNull NotificationCompat.WearableExtender setCustomContentHeight(int height)

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.

public @NonNull NotificationCompat.WearableExtender setCustomSizePreset(int sizePreset)

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.

public @NonNull NotificationCompat.WearableExtender setDismissalId(@Nullable String dismissalId)

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.

public @NonNull NotificationCompat.WearableExtender setDisplayIntent(@Nullable PendingIntent intent)

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" />

public @NonNull NotificationCompat.WearableExtender setGravity(int gravity)

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.

public @NonNull NotificationCompat.WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture)

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.

public @NonNull NotificationCompat.WearableExtender setHintAvoidBackgroundClipping(boolean hintAvoidBackgroundClipping)

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.

public @NonNull NotificationCompat.WearableExtender setHintContentIntentLaunchesActivity(
    boolean hintContentIntentLaunchesActivity
)

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

public @NonNull NotificationCompat.WearableExtender setHintHideIcon(boolean hintHideIcon)

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

public @NonNull NotificationCompat.WearableExtender setHintScreenTimeout(int timeout)

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

public @NonNull NotificationCompat.WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly)

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.

public @NonNull NotificationCompat.WearableExtender setStartScrollBottom(boolean startScrollBottom)

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