Added in API level 20

Summary: Constants | Ctors | Methods | Inherited Methods

Notification.WearableExtender

---

Kotlin |Java

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

java.lang.Object
↳	android.app.Notification.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 Notification.Builder, setting any desired properties.
2. Create a Notification.WearableExtender.
3. Set wearable-specific properties using the add and set methods of Notification.WearableExtender.
4. Call Notification.Builder.extend(Extender) to apply the extensions to a notification.
5. Post the notification to the notification system with the NotificationManager.notify(...) methods.

 Notification notif = new Notification.Builder(mContext)
         .setContentTitle("New mail from " + sender.toString())
         .setContentText(subject)
         .setSmallIcon(R.drawable.new_mail)
         .extend(new Notification.WearableExtender()
                 .setContentIcon(R.drawable.new_mail))
         .build();
 NotificationManager notificationManger =
         (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
 notificationManger.notify(0, notif);

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

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

Summary

Constants
int	SCREEN_TIMEOUT_LONG This constant was deprecated in API level 29. This feature is no longer supported.
int	SCREEN_TIMEOUT_SHORT This constant was deprecated in API level 29. This feature is no longer supported.
int	SIZE_DEFAULT This constant was deprecated in API level 29. Display intents are no longer supported.
int	SIZE_FULL_SCREEN This constant was deprecated in API level 29. Display intents are no longer supported.
int	SIZE_LARGE This constant was deprecated in API level 29. Display intents are no longer supported.
int	SIZE_MEDIUM This constant was deprecated in API level 29. Display intents are no longer supported.
int	SIZE_SMALL This constant was deprecated in API level 29. Display intents are no longer supported.
int	SIZE_XSMALL This constant was deprecated in API level 29. Display intents are no longer supported.
int	UNSET_ACTION_INDEX Sentinel value for an action index that is unset.

Public constructors
WearableExtender() Create a Notification.WearableExtender with default options.
WearableExtender(Notification notif)

Public methods
Notification.WearableExtender	addAction(Notification.Action action) Add a wearable action to this notification.
Notification.WearableExtender	addActions(List<Notification.Action> actions) Adds wearable actions to this notification.
Notification.WearableExtender	addPage(Notification page) This method was deprecated in API level 29. Multiple content pages are no longer supported.
Notification.WearableExtender	addPages(List<Notification> pages) This method was deprecated in API level 29. Multiple content pages are no longer supported.
Notification.WearableExtender	clearActions() Clear all wearable actions present on this builder.
Notification.WearableExtender	clearPages() This method was deprecated in API level 29. Multiple content pages are no longer supported.
Notification.WearableExtender	clone() Creates and returns a copy of this object.
Notification.Builder	extend(Notification.Builder builder) Apply wearable extensions to a notification that is being built.
List<Notification.Action>	getActions() Get the wearable actions present on this notification.
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 Notification.WearableExtender, e.g.
String	getDismissalId() Returns the dismissal id of the notification.
PendingIntent	getDisplayIntent() This method was deprecated in API level 29. Display intents are no longer supported.
int	getGravity() Get the gravity that this notification should have within the available viewport space.
boolean	getHintAmbientBigPicture() This method was deprecated in API level 29. This feature is no longer supported.
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.
List<Notification>	getPages() This method was deprecated in API level 29. 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.
Notification.WearableExtender	setBridgeTag(String bridgeTag) Sets a bridge tag for this notification.
Notification.WearableExtender	setContentAction(int actionIndex) Set an action from this notification's actions as the primary action.
Notification.WearableExtender	setContentIcon(int icon) Set an icon that goes with the content of this notification.
Notification.WearableExtender	setContentIconGravity(int contentIconGravity) Set the gravity that the content icon should have within the notification display.
Notification.WearableExtender	setContentIntentAvailableOffline(boolean contentIntentAvailableOffline) Set whether the content intent is available when the wearable device is not connected to a companion device.
Notification.WearableExtender	setCustomContentHeight(int height) Set the custom height in pixels for the display of this notification's content.
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.
Notification.WearableExtender	setDismissalId(String dismissalId) Sets the dismissal id for this notification.
Notification.WearableExtender	setDisplayIntent(PendingIntent intent) This method was deprecated in API level 29. Display intents are no longer supported.
Notification.WearableExtender	setGravity(int gravity) Set the gravity that this notification should have within the available viewport space.
Notification.WearableExtender	setHintAmbientBigPicture(boolean hintAmbientBigPicture) This method was deprecated in API level 29. This feature is no longer supported.
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.
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.
Notification.WearableExtender	setHintHideIcon(boolean hintHideIcon) Set a hint that this notification's icon should not be displayed.
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.
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.
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.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.app.Notification.Extender abstract Notification.Builder extend(Notification.Builder builder) Apply this extender to a notification builder.

Constants

SCREEN_TIMEOUT_LONG

Added in API level 22
Deprecated in API level 29

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

Added in API level 22
Deprecated in API level 29

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

Added in API level 20
Deprecated in API level 29

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

Added in API level 20
Deprecated in API level 29

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

Added in API level 20
Deprecated in API level 29

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

Added in API level 20
Deprecated in API level 29

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

Added in API level 20
Deprecated in API level 29

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

Added in API level 20
Deprecated in API level 29

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

Added in API level 20

public static final int UNSET_ACTION_INDEX

Sentinel value for an action index that is unset.

Constant Value: -1 (0xffffffff)

Public constructors

WearableExtender

Added in API level 20

public WearableExtender ()

Create a Notification.WearableExtender with default options.

WearableExtender

Added in API level 20

public WearableExtender (Notification notif)

Parameters
notif	Notification

Public methods

addAction

Added in API level 20

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.

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

Returns
Notification.WearableExtender	this object for method chaining

See also:

• Notification.Action

addActions

Added in API level 20

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.

Parameters
actions	List: the actions to add to this notification

Returns
Notification.WearableExtender	this object for method chaining

See also:

• Notification.Action

addPage

Added in API level 20
Deprecated in API level 29

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.

Parameters
page	Notification: the notification to add as another page

Returns
Notification.WearableExtender	this object for method chaining

See also:

• getPages()

addPages

Added in API level 20
Deprecated in API level 29

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.

Parameters
pages	List: a list of notifications

Returns
Notification.WearableExtender	this object for method chaining

See also:

• getPages()

clearActions

Added in API level 20

public Notification.WearableExtender clearActions ()

Clear all wearable actions present on this builder.

Returns
Notification.WearableExtender	this object for method chaining.

See also:

• addAction(Action)

clearPages

Added in API level 20
Deprecated in API level 29

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.

Returns
Notification.WearableExtender	this object for method chaining.

See also:

• addPage(Notification)

clone

Added in API level 20

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

will be true, and that the expression:

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

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

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.

Returns
Notification.WearableExtender	a clone of this instance.

extend

Added in API level 20

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.

Parameters
builder	Notification.Builder: the builder to be modified.

Returns
Notification.Builder	the build object for chaining.

getActions

Added in API level 20

public List<Notification.Action> getActions ()

Get the wearable actions present on this notification.

Returns
List<Notification.Action>

getBridgeTag

Added in API level 26

public String getBridgeTag ()

Returns the bridge tag of the notification.

Returns
String	the bridge tag or null if not present.

getContentAction

Added in API level 20

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.

Returns
int	the action index or UNSET_ACTION_INDEX if no action was selected.

getContentIcon

Added in API level 20
Deprecated in API level 28

public int getContentIcon ()

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

Returns
int

getContentIconGravity

Added in API level 20
Deprecated in API level 28

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.

Returns
int

See also:

• getContentIcon()

getContentIntentAvailableOffline

Added in API level 20

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.

Returns
boolean

getCustomContentHeight

Added in API level 20
Deprecated in API level 28

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

Returns
int

getCustomSizePreset

Added in API level 20
Deprecated in API level 28

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

Returns
int

getDismissalId

Added in API level 24

public String getDismissalId ()

Returns the dismissal id of the notification.

Returns
String	the dismissal id of the notification or null if it has not been set.

getDisplayIntent

Added in API level 20
Deprecated in API level 29

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.

Returns
PendingIntent

getGravity

Added in API level 20
Deprecated in API level 28

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.

Returns
int

getHintAmbientBigPicture

Added in API level 24
Deprecated in API level 29

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.

Returns
boolean	true if it should be displayed in ambient, false otherwise otherwise. The default value is false if this was never set.

getHintAvoidBackgroundClipping

Added in API level 22
Deprecated in API level 28

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.

Returns
boolean	true if it's ok if the background is clipped on the screen, false otherwise. The default value is false if this was never set.

getHintContentIntentLaunchesActivity

Added in API level 24

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

Returns
boolean	true if the content intent will launch an activity and transitions should be generated, false otherwise. The default value is false if this was never set.

getHintHideIcon

Added in API level 20
Deprecated in API level 28

public boolean getHintHideIcon ()

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

Returns
boolean	true if this icon should not be displayed, false otherwise. The default value is false if this was never set.

getHintScreenTimeout

Added in API level 22
Deprecated in API level 28

public int getHintScreenTimeout ()

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

Returns
int	the duration in milliseconds if > 0, or either one of the sentinel values SCREEN_TIMEOUT_SHORT or SCREEN_TIMEOUT_LONG.

getHintShowBackgroundOnly

Added in API level 20
Deprecated in API level 28

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

Returns
boolean

getPages

Added in API level 20
Deprecated in API level 29

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.

Returns
List<Notification>	the pages for this notification

getStartScrollBottom

Added in API level 20

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

Returns
boolean

setBridgeTag

Added in API level 26

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.

Parameters
bridgeTag	String: the bridge tag of the notification.

Returns
Notification.WearableExtender	this object for method chaining

setContentAction

Added in API level 20

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.

Parameters
actionIndex	int: The index of the primary action. If wearable actions were added to the main notification, this index will apply to that list, otherwise it will apply to the regular actions list.

Returns
Notification.WearableExtender

setContentIcon

Added in API level 20
Deprecated in API level 28

public Notification.WearableExtender setContentIcon (int icon)

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

Parameters
icon	int

Returns
Notification.WearableExtender

setContentIconGravity

Added in API level 20
Deprecated in API level 28

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.

Parameters
contentIconGravity	int

Returns
Notification.WearableExtender

See also:

• setContentIcon(int)

setContentIntentAvailableOffline

Added in API level 20

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.

Parameters
contentIntentAvailableOffline	boolean

Returns
Notification.WearableExtender

setCustomContentHeight

Added in API level 20
Deprecated in API level 28

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

Parameters
height	int

Returns
Notification.WearableExtender

setCustomSizePreset

Added in API level 20
Deprecated in API level 28

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

Parameters
sizePreset	int

Returns
Notification.WearableExtender

setDismissalId

Added in API level 24

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.

Parameters
dismissalId	String: the dismissal id of the notification.

Returns
Notification.WearableExtender	this object for method chaining

setDisplayIntent

Added in API level 20
Deprecated in API level 29

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

Parameters
intent	PendingIntent: the PendingIntent for an activity

Returns
Notification.WearableExtender	this object for method chaining

See also:

• getDisplayIntent()

setGravity

Added in API level 20
Deprecated in API level 28

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.

Parameters
gravity	int

Returns
Notification.WearableExtender

setHintAmbientBigPicture

Added in API level 24
Deprecated in API level 29

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.

Parameters
hintAmbientBigPicture	boolean: true to enable converstion and ambient.

Returns
Notification.WearableExtender	this object for method chaining

setHintAvoidBackgroundClipping

Added in API level 22
Deprecated in API level 28

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.

Parameters
hintAvoidBackgroundClipping	boolean: true to avoid clipping if possible.

Returns
Notification.WearableExtender	this object for method chaining

setHintContentIntentLaunchesActivity

Added in API level 24

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.

Parameters
hintContentIntentLaunchesActivity	boolean: true if the content intent will launch an activity and transitions should be generated, false otherwise.

Returns
Notification.WearableExtender	this object for method chaining

setHintHideIcon

Added in API level 20
Deprecated in API level 28

public Notification.WearableExtender setHintHideIcon (boolean hintHideIcon)

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

Parameters
hintHideIcon	boolean: true to hide the icon, false otherwise.

Returns
Notification.WearableExtender	this object for method chaining

setHintScreenTimeout

Added in API level 22
Deprecated in API level 28

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.

Parameters
timeout	int: The requested screen timeout in milliseconds. Can also be either SCREEN_TIMEOUT_SHORT or SCREEN_TIMEOUT_LONG.

Returns
Notification.WearableExtender	this object for method chaining

setHintShowBackgroundOnly

Added in API level 20
Deprecated in API level 28

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

Parameters
hintShowBackgroundOnly	boolean

Returns
Notification.WearableExtender

setStartScrollBottom

Added in API level 20

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

Parameters
startScrollBottom	boolean

Returns
Notification.WearableExtender