NotificationCompat.WearableExtender

public static final class NotificationCompat.WearableExtender
extends Object implements NotificationCompat.Extender

java.lang.Object
   ↳ 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:

  1. Create a NotificationCompat.Builder, setting any desired properties.
  2. Create a NotificationCompat.WearableExtender.
  3. Set wearable-specific properties using the add and set methods of NotificationCompat.WearableExtender.
  4. Call NotificationCompat.Builder.extend(NotificationCompat.Extender) to apply the extensions to a notification.
  5. 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

int SCREEN_TIMEOUT_LONG

This constant is deprecated. This feature is no longer supported.

int SCREEN_TIMEOUT_SHORT

This constant is deprecated. This feature is no longer supported.

int SIZE_DEFAULT

This constant is deprecated. Display intents are no longer supported.

int SIZE_FULL_SCREEN

This constant is deprecated. Display intents are no longer supported.

int SIZE_LARGE

This constant is deprecated. Display intents are no longer supported.

int SIZE_MEDIUM

This constant is deprecated. Display intents are no longer supported.

int SIZE_SMALL

This constant is deprecated. Display intents are no longer supported.

int SIZE_XSMALL

This constant is deprecated. Display intents are no longer supported.

int UNSET_ACTION_INDEX

Sentinel value for an action index that is unset.

Public constructors

WearableExtender()

Create a NotificationCompat.WearableExtender with default options.

WearableExtender(Notification notification)

Public methods

NotificationCompat.WearableExtender addAction(NotificationCompat.Action action)

Add a wearable action to this notification.

NotificationCompat.WearableExtender addActions(List<NotificationCompat.Action> actions)

Adds wearable actions to this notification.

NotificationCompat.WearableExtender addPage(Notification page)

This method is deprecated. Multiple content pages are no longer supported.

NotificationCompat.WearableExtender addPages(List<Notification> pages)

This method is deprecated. Multiple content pages are no longer supported.

NotificationCompat.WearableExtender clearActions()

Clear all wearable actions present on this builder.

NotificationCompat.WearableExtender clearPages()

This method is deprecated. Multiple content pages are no longer supported.

NotificationCompat.WearableExtender clone()
NotificationCompat.Builder extend(NotificationCompat.Builder builder)

Apply wearable extensions to a notification that is being built.

List<NotificationCompat.Action> getActions()

Get the wearable actions present on this notification.

Bitmap getBackground()

This method is deprecated. Background images are no longer supported.

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

This method is deprecated. This method has no effect starting with Wear 2.0.

int getContentIconGravity()

This method is deprecated. This method has no effect starting with Wear 2.0.

boolean getContentIntentAvailableOffline()

Get whether the content intent is available when the wearable device is not connected to a companion device.

int getCustomContentHeight()

This method is deprecated. This method has no effect starting with Wear 2.0.

int getCustomSizePreset()

This method is deprecated. This method has no effect starting with Wear 2.0.

String getDismissalId()

Returns the dismissal id of the notification.

PendingIntent getDisplayIntent()

This method is deprecated. Display intents are no longer supported.

int getGravity()

This method is deprecated. This method has no effect starting with Wear 2.0.

boolean getHintAmbientBigPicture()

This method is deprecated. This feature is no longer supported.

boolean getHintAvoidBackgroundClipping()

This method is deprecated. This method has no effect starting with Wear 2.0.

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

This method is deprecated. This method has no effect starting with Wear 2.0.

int getHintScreenTimeout()

This method is deprecated. This method has no effect starting with Wear 2.0.

boolean getHintShowBackgroundOnly()

This method is deprecated. This method has no effect starting with Wear 2.0.

List<Notification> getPages()

This method is deprecated. Multiple content pages are no longer supported.

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.

NotificationCompat.WearableExtender setBackground(Bitmap background)

This method is deprecated. Background images are no longer supported.

NotificationCompat.WearableExtender setBridgeTag(String bridgeTag)

Sets a bridge tag for this notification.

NotificationCompat.WearableExtender setContentAction(int actionIndex)

Set an action from this notification's actions as the primary action.

NotificationCompat.WearableExtender setContentIcon(int icon)

This method is deprecated. This method has no effect starting with Wear 2.0.

NotificationCompat.WearableExtender setContentIconGravity(int contentIconGravity)

This method is deprecated. This method has no effect starting with Wear 2.0.

NotificationCompat.WearableExtender setContentIntentAvailableOffline(boolean contentIntentAvailableOffline)

Set whether the content intent is available when the wearable device is not connected to a companion device.

NotificationCompat.WearableExtender setCustomContentHeight(int height)

This method is deprecated. This method has no effect starting with Wear 2.0.

NotificationCompat.WearableExtender setCustomSizePreset(int sizePreset)

This method is deprecated. This method has no effect starting with Wear 2.0.

NotificationCompat.WearableExtender setDismissalId(String dismissalId)

Sets the dismissal id for this notification.

NotificationCompat.WearableExtender setDisplayIntent(PendingIntent intent)

This method is deprecated. Display intents are no longer supported.

NotificationCompat.WearableExtender setGravity(int gravity)

This method is deprecated. This method has no effect starting with Wear 2.0.

NotificationCompat.WearableExtender setHintAmbientBigPicture(boolean hintAmbientBigPicture)

This method is deprecated. This feature is no longer supported.

NotificationCompat.WearableExtender setHintAvoidBackgroundClipping(boolean hintAvoidBackgroundClipping)

This method is deprecated. This method has no effect starting with Wear 2.0.

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.

NotificationCompat.WearableExtender setHintHideIcon(boolean hintHideIcon)

This method is deprecated. This method has no effect starting with Wear 2.0.

NotificationCompat.WearableExtender setHintScreenTimeout(int timeout)

This method is deprecated. This method has no effect.

NotificationCompat.WearableExtender setHintShowBackgroundOnly(boolean hintShowBackgroundOnly)

This method is deprecated. This method has no effect starting with Wear 2.0.

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.

Inherited methods

Constants

SCREEN_TIMEOUT_LONG

public static final int SCREEN_TIMEOUT_LONG

This constant is deprecated.
This feature is no longer supported.

Sentinel value for use with setHintScreenTimeout(int) to keep the screen on for a longer amount of time when this notification is displayed on the screen.

Constant Value: -1 (0xffffffff)

SCREEN_TIMEOUT_SHORT

public static final int SCREEN_TIMEOUT_SHORT

This constant is deprecated.
This feature is no longer supported.

Sentinel value for use with setHintScreenTimeout(int) to keep the screen on for a short amount of time when this notification is displayed on the screen. This is the default value.

Constant Value: 0 (0x00000000)

SIZE_DEFAULT

public static final int SIZE_DEFAULT

This constant is deprecated.
Display intents are no longer supported.

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

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

Constant Value: 0 (0x00000000)

SIZE_FULL_SCREEN

public static final int SIZE_FULL_SCREEN

This constant is deprecated.
Display intents are no longer supported.

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

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

Constant Value: 5 (0x00000005)

SIZE_LARGE

public static final int SIZE_LARGE

This constant is deprecated.
Display intents are no longer supported.

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

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

Constant Value: 4 (0x00000004)

SIZE_MEDIUM

public static final int SIZE_MEDIUM

This constant is deprecated.
Display intents are no longer supported.

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

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

Constant Value: 3 (0x00000003)

SIZE_SMALL

public static final int SIZE_SMALL

This constant is deprecated.
Display intents are no longer supported.

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

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

Constant Value: 2 (0x00000002)

SIZE_XSMALL

public static final int SIZE_XSMALL

This constant is deprecated.
Display intents are no longer supported.

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

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

Constant Value: 1 (0x00000001)

UNSET_ACTION_INDEX

public static final int UNSET_ACTION_INDEX

Sentinel value for an action index that is unset.

Constant Value: -1 (0xffffffff)

Public constructors

WearableExtender

public WearableExtender ()

Create a NotificationCompat.WearableExtender with default options.

WearableExtender

public WearableExtender (Notification notification)

Parameters
notification Notification

Public methods

addAction

public NotificationCompat.WearableExtender addAction (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 NotificationCompat.Builder.addAction(NotificationCompat.Action). This allows for customization of which actions display on different devices.

Parameters
action NotificationCompat.Action: the action to add to this notification

Returns
NotificationCompat.WearableExtender this object for method chaining

addActions

public NotificationCompat.WearableExtender addActions (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 NotificationCompat.Builder.addAction(NotificationCompat.Action). This allows for customization of which actions display on different devices.

Parameters
actions List: the actions to add to this notification

Returns
NotificationCompat.WearableExtender this object for method chaining

addPage

public NotificationCompat.WearableExtender addPage (Notification page)

This method is deprecated.
Multiple content pages are no longer supported.

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.

Parameters
page Notification: the notification to add as another page

Returns
NotificationCompat.WearableExtender this object for method chaining

See also:

addPages

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

This method is deprecated.
Multiple content pages are no longer supported.

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.

Parameters
pages List: a list of notifications

Returns
NotificationCompat.WearableExtender this object for method chaining

See also:

clearActions

public NotificationCompat.WearableExtender clearActions ()

Clear all wearable actions present on this builder.