Notification.WearableExtender

SCREEN_TIMEOUT_LONG

public static final int SCREEN_TIMEOUT_LONG

This constant was deprecated in API level 29.
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 was deprecated in API level 29.
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 was deprecated in API level 29.
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 was deprecated in API level 29.
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 was deprecated in API level 29.
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 was deprecated in API level 29.
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 was deprecated in API level 29.
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 was deprecated in API level 29.
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)

WearableExtender

public WearableExtender ()

Create a Notification.WearableExtender with default options.

WearableExtender

public WearableExtender (Notification notif)

addAction

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

addActions

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

addPage

public Notification.WearableExtender addPage (Notification page)

This method was deprecated in API level 29.
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.

addPages

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

This method was deprecated in API level 29.
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.

clearActions

public Notification.WearableExtender clearActions ()

Clear all wearable actions present on this builder.

clearPages

public Notification.WearableExtender clearPages ()

This method was deprecated in API level 29.
Multiple content pages are no longer supported.

Clear all additional pages present on this builder.

clone

public Notification.WearableExtender clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

 x.clone().getClass() == x.getClass()

 x.clone().equals(x)

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

extend

public Notification.Builder extend (Notification.Builder builder)

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

getActions

public List<Notification.Action> getActions ()

Get the wearable actions present on this notification.

getBridgeTag

public String getBridgeTag ()

Returns the bridge tag of the notification.

getContentAction

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.

getContentIcon

public int getContentIcon ()

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

getContentIconGravity

public int getContentIconGravity ()

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

getContentIntentAvailableOffline

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.

getCustomContentHeight

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(PendingIntent). See also setCustomSizePreset(int) and setCustomContentHeight(int).

getCustomSizePreset

public int getCustomSizePreset ()

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

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

getDismissalId

public String getDismissalId ()

Returns the dismissal id of the notification.

getDisplayIntent

public PendingIntent getDisplayIntent ()

This method was deprecated in API level 29.
Display intents are no longer supported.

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

getGravity

public int getGravity ()

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

getHintAmbientBigPicture

public boolean getHintAmbientBigPicture ()

This method was deprecated in API level 29.
This feature is no longer supported.

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.

getHintAvoidBackgroundClipping

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.

getHintContentIntentLaunchesActivity

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

getHintHideIcon

public boolean getHintHideIcon ()

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

getHintScreenTimeout

public int getHintScreenTimeout ()

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

getHintShowBackgroundOnly

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

getPages

public List<Notification> getPages ()

This method was deprecated in API level 29.
Multiple content pages are no longer supported.

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.

getStartScrollBottom

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

setBridgeTag

public Notification.WearableExtender setBridgeTag (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.

setContentAction

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

setContentIcon

public Notification.WearableExtender setContentIcon (int icon)

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

setContentIconGravity

public Notification.WearableExtender setContentIconGravity (int contentIconGravity)

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

setContentIntentAvailableOffline

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

setCustomContentHeight

public Notification.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(PendingIntent). See also setCustomSizePreset(int) and getCustomContentHeight().

setCustomSizePreset

public Notification.WearableExtender setCustomSizePreset (int sizePreset)

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

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

setDismissalId

public Notification.WearableExtender setDismissalId (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.

setDisplayIntent

public Notification.WearableExtender setDisplayIntent (PendingIntent intent)

This method was deprecated in API level 29.
Display intents are no longer supported.

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 | PendingIntent.FLAG_MUTABLE_UNAUDITED);
 Notification notif = new Notification.Builder(context)
         .extend(new Notification.WearableExtender()
                 .setDisplayIntent(displayPendingIntent)
                 .setCustomSizePreset(Notification.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" />

setGravity

public Notification.WearableExtender setGravity (int gravity)

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

setHintAmbientBigPicture

public Notification.WearableExtender setHintAmbientBigPicture (boolean hintAmbientBigPicture)

This method was deprecated in API level 29.
This feature is no longer supported.

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.

setHintAvoidBackgroundClipping

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

setHintContentIntentLaunchesActivity

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

setHintHideIcon

public Notification.WearableExtender setHintHideIcon (boolean hintHideIcon)

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

setHintScreenTimeout

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

setHintShowBackgroundOnly

public Notification.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(Notification).

setStartScrollBottom

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