# Notification.WearableExtender Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # WearableExtender *** ** * ** *** Kotlin\|[Java](https://developer.android.com/reference/android/app/Notification.WearableExtender "View this page in Java") ``` class WearableExtender : Notification.Extender ``` |---|----------------------------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) || | ↳ | [android.app.Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#) | Helper class to add wearable extensions to notifications. See[Creating Notifications for Android Wear](https://developer.android.com/wear/notifications/creating.html)for more information on how to use this class. To create a notification with wearable extensions: 1. Create a[android.app.Notification.Builder](https://developer.android.com/reference/kotlin/android/app/Notification.Builder), setting any desired properties. 2. Create a[android.app.Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#). 3. Set wearable-specific properties using the`add`and`set`methods of[android.app.Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#). 4. Call[android.app.Notification.Builder#extend](https://developer.android.com/reference/kotlin/android/app/Notification.Builder#extend(android.app.Notification.Extender))to apply the extensions to a notification. 5. Post the notification to the notification system with the`NotificationManager.notify(...)`methods. ```kotlin 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. ```kotlin Notification.WearableExtender wearableExtender = new Notification.WearableExtender( notification); List pages = wearableExtender.getPages(); ``` ## Summary | Constants || |----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SCREEN_TIMEOUT_LONG](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SCREEN_TIMEOUT_LONG:kotlin.Int) Sentinel value for use with[setHintScreenTimeout](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setHintScreenTimeout(kotlin.Int))to keep the screen on for a longer amount of time when this notification is displayed on the screen. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SCREEN_TIMEOUT_SHORT](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SCREEN_TIMEOUT_SHORT:kotlin.Int) Sentinel value for use with[setHintScreenTimeout](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setHintScreenTimeout(kotlin.Int))to keep the screen on for a short amount of time when this notification is displayed on the screen. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SIZE_DEFAULT](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SIZE_DEFAULT:kotlin.Int) Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification with default sizing. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SIZE_FULL_SCREEN](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SIZE_FULL_SCREEN:kotlin.Int) Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification full screen. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SIZE_LARGE](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SIZE_LARGE:kotlin.Int) Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification with a large size. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SIZE_MEDIUM](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SIZE_MEDIUM:kotlin.Int) Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification with a medium size. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SIZE_SMALL](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SIZE_SMALL:kotlin.Int) Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification with a small size. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SIZE_XSMALL](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SIZE_XSMALL:kotlin.Int) Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification with an extra small size. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [UNSET_ACTION_INDEX](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#UNSET_ACTION_INDEX:kotlin.Int) Sentinel value for an action index that is unset. | | Public constructors || |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | [WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#WearableExtender())`()` Create a[android.app.Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)with default options. | | [WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#WearableExtender(android.app.Notification))`(`notif:` `[Notification](https://developer.android.com/reference/kotlin/android/app/Notification)!`)`
| | Public methods || |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [addAction](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#addAction(android.app.Notification.Action))`(`action:` `[Notification.Action](https://developer.android.com/reference/kotlin/android/app/Notification.Action)!`)` Add a wearable action to this notification. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [addActions](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#addActions(kotlin.collections.MutableList))`(`actions:` `[MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)<[Notification.Action](https://developer.android.com/reference/kotlin/android/app/Notification.Action)!>!`)` Adds wearable actions to this notification. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [addPage](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#addPage(android.app.Notification))`(`page:` `[Notification](https://developer.android.com/reference/kotlin/android/app/Notification)!`)` Add an additional page of content to display with this notification. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [addPages](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#addPages(kotlin.collections.MutableList))`(`pages:` `[MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)<[Notification](https://developer.android.com/reference/kotlin/android/app/Notification)!>!`)` Add additional pages of content to display with this notification. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [clearActions](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#clearActions())`()` Clear all wearable actions present on this builder. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [clearPages](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#clearPages())`()` Clear all additional pages present on this builder. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [clone](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#clone())`()`
| | [Notification.Builder](https://developer.android.com/reference/kotlin/android/app/Notification.Builder)! | [extend](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#extend(android.app.Notification.Builder))`(`builder:` `[Notification.Builder](https://developer.android.com/reference/kotlin/android/app/Notification.Builder)!`)` Apply wearable extensions to a notification that is being built. | | [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)\<[Notification.Action](https://developer.android.com/reference/kotlin/android/app/Notification.Action)!\>! | [getActions](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getActions())`()` Get the wearable actions present on this notification. | | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getBridgeTag](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getBridgeTag())`()` Returns the bridge tag of the notification. | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getContentAction](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getContentAction())`()` Get the index of the notification action, if any, that was specified as the primary action. | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getContentIcon](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getContentIcon())`()` Get an icon that goes with the content of this notification. | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getContentIconGravity](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getContentIconGravity())`()` Get the gravity that the content icon should have within the notification display. | | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [getContentIntentAvailableOffline](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getContentIntentAvailableOffline())`()` Get whether the content intent is available when the wearable device is not connected to a companion device. | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getCustomContentHeight](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getCustomContentHeight())`()` Get the custom height in pixels for the display of this notification's content. | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getCustomSizePreset())`()` Get the custom size preset for the display of this notification out of the available presets found in[android.app.Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#), e. | | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getDismissalId](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getDismissalId())`()` Returns the dismissal id of the notification. | | [PendingIntent](https://developer.android.com/reference/kotlin/android/app/PendingIntent)! | [getDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getDisplayIntent())`()` Get the intent to launch inside of an activity view when displaying this notification. | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getGravity](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getGravity())`()` Get the gravity that this notification should have within the available viewport space. | | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [getHintAmbientBigPicture](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getHintAmbientBigPicture())`()` Get a hint that this notification's[BigPictureStyle](https://developer.android.com/reference/kotlin/android/app/Notification.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. | | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [getHintAvoidBackgroundClipping](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [getHintContentIntentLaunchesActivity](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getHintContentIntentLaunchesActivity())`()` Get a hint that this notification's content intent will launch an[Activity](https://developer.android.com/reference/kotlin/android/app/Activity)directly, telling the platform that it can generate the appropriate transitions | | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [getHintHideIcon](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getHintHideIcon())`()` Get a hint that this notification's icon should not be displayed. | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getHintScreenTimeout](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getHintScreenTimeout())`()` Get the duration, in milliseconds, that the screen should remain on for when this notification is displayed. | | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [getHintShowBackgroundOnly](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getHintShowBackgroundOnly())`()` Get a visual hint that only the background image of this notification should be displayed, and other semantic content should be hidden. | | [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)\<[Notification](https://developer.android.com/reference/kotlin/android/app/Notification)!\>! | [getPages](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getPages())`()` Get the array of additional pages of content for displaying this notification. | | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [getStartScrollBottom](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#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](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setBridgeTag](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setBridgeTag(kotlin.String))`(`bridgeTag:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Sets a bridge tag for this notification. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setContentAction](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setContentAction(kotlin.Int))`(`actionIndex:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Set an action from this notification's actions as the primary action. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setContentIcon](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setContentIcon(kotlin.Int))`(`icon:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Set an icon that goes with the content of this notification. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setContentIconGravity](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setContentIconGravity(kotlin.Int))`(`contentIconGravity:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Set the gravity that the content icon should have within the notification display. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setContentIntentAvailableOffline](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setContentIntentAvailableOffline(kotlin.Boolean))`(`contentIntentAvailableOffline:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Set whether the content intent is available when the wearable device is not connected to a companion device. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setCustomContentHeight](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomContentHeight(kotlin.Int))`(`height:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Set the custom height in pixels for the display of this notification's content. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))`(`sizePreset:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Set the custom size preset for the display of this notification out of the available presets found in[android.app.Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#), e. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setDismissalId](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDismissalId(kotlin.String))`(`dismissalId:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Sets the dismissal id for this notification. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDisplayIntent(android.app.PendingIntent))`(`intent:` `[PendingIntent](https://developer.android.com/reference/kotlin/android/app/PendingIntent)!`)` Set an intent to launch inside of an activity view when displaying this notification. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setGravity](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setGravity(kotlin.Int))`(`gravity:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Set the gravity that this notification should have within the available viewport space. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setHintAmbientBigPicture](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setHintAmbientBigPicture(kotlin.Boolean))`(`hintAmbientBigPicture:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Set a hint that this notification's[BigPictureStyle](https://developer.android.com/reference/kotlin/android/app/Notification.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. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setHintAvoidBackgroundClipping](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setHintAvoidBackgroundClipping(kotlin.Boolean))`(`hintAvoidBackgroundClipping:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` 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](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setHintContentIntentLaunchesActivity](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setHintContentIntentLaunchesActivity(kotlin.Boolean))`(`hintContentIntentLaunchesActivity:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Set a hint that this notification's content intent will launch an[Activity](https://developer.android.com/reference/kotlin/android/app/Activity)directly, telling the platform that it can generate the appropriate transitions. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setHintHideIcon](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setHintHideIcon(kotlin.Boolean))`(`hintHideIcon:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Set a hint that this notification's icon should not be displayed. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setHintScreenTimeout](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setHintScreenTimeout(kotlin.Int))`(`timeout:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Set a hint that the screen should remain on for at least this duration when this notification is displayed on the screen. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setHintShowBackgroundOnly](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setHintShowBackgroundOnly(kotlin.Boolean))`(`hintShowBackgroundOnly:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Set a visual hint that only the background image of this notification should be displayed, and other semantic content should be hidden. | | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | [setStartScrollBottom](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setStartScrollBottom(kotlin.Boolean))`(`startScrollBottom:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` 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. | ## Constants ### SCREEN_TIMEOUT_LONG Added in[API level 22](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val SCREEN_TIMEOUT_LONG: Int ``` **Deprecated:** *This feature is no longer supported.* Sentinel value for use with[setHintScreenTimeout](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setHintScreenTimeout(kotlin.Int))to keep the screen on for a longer amount of time when this notification is displayed on the screen. Value: -1 ### SCREEN_TIMEOUT_SHORT Added in[API level 22](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val SCREEN_TIMEOUT_SHORT: Int ``` **Deprecated:** *This feature is no longer supported.* Sentinel value for use with[setHintScreenTimeout](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setHintScreenTimeout(kotlin.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. Value: 0 ### SIZE_DEFAULT Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val SIZE_DEFAULT: Int ``` **Deprecated:** *Display intents are no longer supported.* Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification with default sizing. For custom display notifications created using[setDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDisplayIntent(android.app.PendingIntent)), the default is[SIZE_MEDIUM](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SIZE_MEDIUM:kotlin.Int). All other notifications size automatically based on their content. Value: 0 ### SIZE_FULL_SCREEN Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val SIZE_FULL_SCREEN: Int ``` **Deprecated:** *Display intents are no longer supported.* Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification full screen. This value is only applicable for custom display notifications created using[setDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDisplayIntent(android.app.PendingIntent)). Value: 5 ### SIZE_LARGE Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val SIZE_LARGE: Int ``` **Deprecated:** *Display intents are no longer supported.* Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification with a large size. This value is only applicable for custom display notifications created using[setDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDisplayIntent(android.app.PendingIntent)). Value: 4 ### SIZE_MEDIUM Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val SIZE_MEDIUM: Int ``` **Deprecated:** *Display intents are no longer supported.* Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification with a medium size. This value is only applicable for custom display notifications created using[setDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDisplayIntent(android.app.PendingIntent)). Value: 3 ### SIZE_SMALL Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val SIZE_SMALL: Int ``` **Deprecated:** *Display intents are no longer supported.* Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification with a small size. This value is only applicable for custom display notifications created using[setDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDisplayIntent(android.app.PendingIntent)). Value: 2 ### SIZE_XSMALL Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val SIZE_XSMALL: Int ``` **Deprecated:** *Display intents are no longer supported.* Size value for use with[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))to show this notification with an extra small size. This value is only applicable for custom display notifications created using[setDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDisplayIntent(android.app.PendingIntent)). Value: 1 ### UNSET_ACTION_INDEX Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val UNSET_ACTION_INDEX: Int ``` Sentinel value for an action index that is unset. Value: -1 ## Public constructors ### WearableExtender Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` WearableExtender() ``` Create a[android.app.Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)with default options. ### WearableExtender Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` WearableExtender(notif: Notification!) ``` ## Public methods ### addAction Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun addAction(action: Notification.Action!): Notification.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 android.app.Notification.Builder#addAction. This allows for customization of which actions display on different devices. | Parameters || |----------|-----------------------------------------------------------------------------------------------------------------------------------------------| | `action` | [Notification.Action](https://developer.android.com/reference/kotlin/android/app/Notification.Action)!:the action to add to this notification | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | **See Also** - [android.app.Notification.Action](https://developer.android.com/reference/kotlin/android/app/Notification.Action) ### addActions Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun addActions(actions: MutableList!): Notification.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 android.app.Notification.Builder#addAction. This allows for customization of which actions display on different devices. | Parameters || |-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `actions` | [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)\<[Notification.Action](https://developer.android.com/reference/kotlin/android/app/Notification.Action)!\>!:the actions to add to this notification | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | **See Also** - [android.app.Notification.Action](https://developer.android.com/reference/kotlin/android/app/Notification.Action) ### addPage Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun addPage(page: Notification!): Notification.WearableExtender! ``` **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](https://developer.android.com/reference/kotlin/android/app/Notification)!:the notification to add as another page | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | **See Also** - [android.app.Notification.WearableExtender#getPages](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getPages()) ### addPages Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun addPages(pages: MutableList!): Notification.WearableExtender! ``` **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` | [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)\<[Notification](https://developer.android.com/reference/kotlin/android/app/Notification)!\>!:a list of notifications | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | **See Also** - [android.app.Notification.WearableExtender#getPages](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getPages()) ### clearActions Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun clearActions(): Notification.WearableExtender! ``` Clear all wearable actions present on this builder. | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | **See Also** - [#addAction](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#addAction(android.app.Notification.Action)) ### clearPages Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun clearPages(): Notification.WearableExtender! ``` **Deprecated:** *Multiple content pages are no longer supported.* Clear all additional pages present on this builder. | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | **See Also** - [#addPage](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#addPage(android.app.Notification)) ### clone Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun clone(): Notification.WearableExtender! ``` | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | a clone of this instance. | | Exceptions || |----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `java.lang.CloneNotSupportedException` | if the object's class does not support the`Cloneable`interface. Subclasses that override the`clone`method can also throw this exception to indicate that an instance cannot be cloned. | ### extend Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun extend(builder: Notification.Builder!): Notification.Builder! ``` Apply wearable extensions to a notification that is being built. This is typically called by the[android.app.Notification.Builder#extend](https://developer.android.com/reference/kotlin/android/app/Notification.Builder#extend(android.app.Notification.Extender))method of[android.app.Notification.Builder](https://developer.android.com/reference/kotlin/android/app/Notification.Builder). | Parameters || |-----------|-------------------------------------------------------------------------------------------------------------------------------------| | `builder` | [Notification.Builder](https://developer.android.com/reference/kotlin/android/app/Notification.Builder)!:the builder to be modified | | Return || |----------------------------------------------------------------------------------------------------------|-------------------------------| | [Notification.Builder](https://developer.android.com/reference/kotlin/android/app/Notification.Builder)! | the build object for chaining | ### getActions Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getActions(): MutableList! ``` Get the wearable actions present on this notification. ### getBridgeTag Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getBridgeTag(): String! ``` Returns the bridge tag of the notification. | Return || |-----------------------------------------------------------------------------------|----------------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | the bridge tag or`null`if not present. | ### getContentAction Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` 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. | Return || |----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | the action index or[UNSET_ACTION_INDEX](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#UNSET_ACTION_INDEX:kotlin.Int)if no action was selected | ### getContentIcon Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getContentIcon(): Int ``` **Deprecated:** *Deprecated in Java.* Get an icon that goes with the content of this notification. ### getContentIconGravity Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getContentIconGravity(): Int ``` **Deprecated:** *Deprecated in Java.* Get the gravity that the content icon should have within the notification display. Supported values include[android.view.Gravity#START](https://developer.android.com/reference/kotlin/android/view/Gravity.html#START:kotlin.Int)and[android.view.Gravity#END](https://developer.android.com/reference/kotlin/android/view/Gravity.html#END:kotlin.Int). The default value is[android.view.Gravity#END](https://developer.android.com/reference/kotlin/android/view/Gravity.html#END:kotlin.Int). **See Also** - [#getContentIcon](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getContentIcon()) ### getContentIntentAvailableOffline Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` 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`. ### getCustomContentHeight Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getCustomContentHeight(): Int ``` **Deprecated:** *Deprecated in Java.* 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](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDisplayIntent(android.app.PendingIntent)). See also[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))and[setCustomContentHeight](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomContentHeight(kotlin.Int)). ### getCustomSizePreset Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getCustomSizePreset(): Int ``` **Deprecated:** *Deprecated in Java.* Get the custom size preset for the display of this notification out of the available presets found in[android.app.Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#), e.g.[SIZE_LARGE](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SIZE_LARGE:kotlin.Int). Some custom size presets are only applicable for custom display notifications created using[setDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDisplayIntent(android.app.PendingIntent)). Check the documentation for the preset in question. See also[setCustomContentHeight](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomContentHeight(kotlin.Int))and[setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int)). ### getDismissalId Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getDismissalId(): String! ``` Returns the dismissal id of the notification. | Return || |-----------------------------------------------------------------------------------|---------------------------------------------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | the dismissal id of the notification or`null`if it has not been set | ### getDisplayIntent Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getDisplayIntent(): PendingIntent! ``` **Deprecated:** *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 Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getGravity(): Int ``` **Deprecated:** *Deprecated in Java.* Get the gravity that this notification should have within the available viewport space. Supported values include[android.view.Gravity#TOP](https://developer.android.com/reference/kotlin/android/view/Gravity.html#TOP:kotlin.Int),[android.view.Gravity#CENTER_VERTICAL](https://developer.android.com/reference/kotlin/android/view/Gravity.html#CENTER_VERTICAL:kotlin.Int)and[android.view.Gravity#BOTTOM](https://developer.android.com/reference/kotlin/android/view/Gravity.html#BOTTOM:kotlin.Int). The default value is[android.view.Gravity#BOTTOM](https://developer.android.com/reference/kotlin/android/view/Gravity.html#BOTTOM:kotlin.Int). ### getHintAmbientBigPicture Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getHintAmbientBigPicture(): Boolean ``` **Deprecated:** *This feature is no longer supported.* Get a hint that this notification's[BigPictureStyle](https://developer.android.com/reference/kotlin/android/app/Notification.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. | Return || |------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getHintAvoidBackgroundClipping(): Boolean ``` **Deprecated:** *Deprecated in Java.* 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. | Return || |------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getHintContentIntentLaunchesActivity(): Boolean ``` Get a hint that this notification's content intent will launch an[Activity](https://developer.android.com/reference/kotlin/android/app/Activity)directly, telling the platform that it can generate the appropriate transitions | Return || |------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getHintHideIcon(): Boolean ``` **Deprecated:** *Deprecated in Java.* Get a hint that this notification's icon should not be displayed. | Return || |------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getHintScreenTimeout(): Int ``` **Deprecated:** *Deprecated in Java.* Get the duration, in milliseconds, that the screen should remain on for when this notification is displayed. | Return || |----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | the duration in milliseconds if \> 0, or either one of the sentinel values[SCREEN_TIMEOUT_SHORT](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SCREEN_TIMEOUT_SHORT:kotlin.Int)or[SCREEN_TIMEOUT_LONG](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SCREEN_TIMEOUT_LONG:kotlin.Int). | ### getHintShowBackgroundOnly Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getHintShowBackgroundOnly(): Boolean ``` **Deprecated:** *Deprecated in Java.* 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[android.app.Notification.WearableExtender#addPage](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#addPage(android.app.Notification)). ### getPages Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getPages(): MutableList! ``` **Deprecated:** *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. | Return || |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)<[Notification](https://developer.android.com/reference/kotlin/android/app/Notification)!>! | the pages for this notification | ### getStartScrollBottom Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` 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). ### setBridgeTag Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setBridgeTag(bridgeTag: String!): Notification.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](https://developer.android.com/wear/notifications/index.html)for more information. | Parameters || |-------------|----------------------------------------------------------------------------------------------------------------------| | `bridgeTag` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:the bridge tag of the notification | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | ### setContentAction Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setContentAction(actionIndex: Int): Notification.WearableExtender! ``` Set an action from this notification's actions as the primary action. If the action has a[RemoteInput](https://developer.android.com/reference/kotlin/android/app/RemoteInput)associated with it, shortcuts to the options for that input are shown directly on the notification. | Parameters || |---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `actionIndex` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):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. | ### setContentIcon Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setContentIcon(icon: Int): Notification.WearableExtender! ``` **Deprecated:** *Deprecated in Java.* Set an icon that goes with the content of this notification. ### setContentIconGravity Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setContentIconGravity(contentIconGravity: Int): Notification.WearableExtender! ``` **Deprecated:** *Deprecated in Java.* Set the gravity that the content icon should have within the notification display. Supported values include[android.view.Gravity#START](https://developer.android.com/reference/kotlin/android/view/Gravity.html#START:kotlin.Int)and[android.view.Gravity#END](https://developer.android.com/reference/kotlin/android/view/Gravity.html#END:kotlin.Int). The default value is[android.view.Gravity#END](https://developer.android.com/reference/kotlin/android/view/Gravity.html#END:kotlin.Int). **See Also** - [#setContentIcon](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setContentIcon(kotlin.Int)) ### setContentIntentAvailableOffline Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setContentIntentAvailableOffline(contentIntentAvailableOffline: Boolean): Notification.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`. ### setCustomContentHeight Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setCustomContentHeight(height: Int): Notification.WearableExtender! ``` **Deprecated:** *Deprecated in Java.* 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[android.app.Notification.WearableExtender#setDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDisplayIntent(android.app.PendingIntent)). See also[android.app.Notification.WearableExtender#setCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomSizePreset(kotlin.Int))and[getCustomContentHeight](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getCustomContentHeight()). ### setCustomSizePreset Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setCustomSizePreset(sizePreset: Int): Notification.WearableExtender! ``` **Deprecated:** *Deprecated in Java.* Set the custom size preset for the display of this notification out of the available presets found in[android.app.Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#), e.g.[SIZE_LARGE](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SIZE_LARGE:kotlin.Int). Some custom size presets are only applicable for custom display notifications created using[android.app.Notification.WearableExtender#setDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setDisplayIntent(android.app.PendingIntent)). Check the documentation for the preset in question. See also[setCustomContentHeight](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#setCustomContentHeight(kotlin.Int))and[getCustomSizePreset](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getCustomSizePreset()). ### setDismissalId Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setDismissalId(dismissalId: String!): Notification.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](https://developer.android.com/wear/notifications/index.html)for more information. | Parameters || |---------------|------------------------------------------------------------------------------------------------------------------------| | `dismissalId` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:the dismissal id of the notification | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | ### setDisplayIntent Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setDisplayIntent(intent: PendingIntent!): Notification.WearableExtender! ``` **Deprecated:** *Display intents are no longer supported.* Set an intent to launch inside of an activity view when displaying this notification. The[PendingIntent](https://developer.android.com/reference/kotlin/android/app/PendingIntent)provided should be for an activity. ```kotlin 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: ```kotlin ``` | Parameters || |----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `intent` | [PendingIntent](https://developer.android.com/reference/kotlin/android/app/PendingIntent)!:the[PendingIntent](https://developer.android.com/reference/kotlin/android/app/PendingIntent)for an activity | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | **See Also** - [android.app.Notification.WearableExtender#getDisplayIntent](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#getDisplayIntent()) ### setGravity Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setGravity(gravity: Int): Notification.WearableExtender! ``` **Deprecated:** *Deprecated in Java.* Set the gravity that this notification should have within the available viewport space. Supported values include[android.view.Gravity#TOP](https://developer.android.com/reference/kotlin/android/view/Gravity.html#TOP:kotlin.Int),[android.view.Gravity#CENTER_VERTICAL](https://developer.android.com/reference/kotlin/android/view/Gravity.html#CENTER_VERTICAL:kotlin.Int)and[android.view.Gravity#BOTTOM](https://developer.android.com/reference/kotlin/android/view/Gravity.html#BOTTOM:kotlin.Int). The default value is[android.view.Gravity#BOTTOM](https://developer.android.com/reference/kotlin/android/view/Gravity.html#BOTTOM:kotlin.Int). ### setHintAmbientBigPicture Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setHintAmbientBigPicture(hintAmbientBigPicture: Boolean): Notification.WearableExtender! ``` **Deprecated:** *This feature is no longer supported.* Set a hint that this notification's[BigPictureStyle](https://developer.android.com/reference/kotlin/android/app/Notification.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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html):`true`to enable conversation and ambient | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | ### setHintAvoidBackgroundClipping Added in[API level 22](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setHintAvoidBackgroundClipping(hintAvoidBackgroundClipping: Boolean): Notification.WearableExtender! ``` **Deprecated:** *Deprecated in Java.* 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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html):`true`to avoid clipping if possible | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | ### setHintContentIntentLaunchesActivity Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setHintContentIntentLaunchesActivity(hintContentIntentLaunchesActivity: Boolean): Notification.WearableExtender! ``` Set a hint that this notification's content intent will launch an[Activity](https://developer.android.com/reference/kotlin/android/app/Activity)directly, telling the platform that it can generate the appropriate transitions. | Parameters || |-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `hintContentIntentLaunchesActivity` | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html):`true`if the content intent will launch an activity and transitions should be generated, false otherwise. | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | ### setHintHideIcon Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setHintHideIcon(hintHideIcon: Boolean): Notification.WearableExtender! ``` **Deprecated:** *Deprecated in Java.* Set a hint that this notification's icon should not be displayed. | Parameters || |----------------|----------------------------------------------------------------------------------------------------------------------------| | `hintHideIcon` | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html):`true`to hide the icon,`false`otherwise | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | ### setHintScreenTimeout Added in[API level 22](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setHintScreenTimeout(timeout: Int): Notification.WearableExtender! ``` **Deprecated:** *Deprecated in Java.* 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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the requested screen timeout in milliseconds. Can also be either[SCREEN_TIMEOUT_SHORT](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SCREEN_TIMEOUT_SHORT:kotlin.Int)or[SCREEN_TIMEOUT_LONG](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#SCREEN_TIMEOUT_LONG:kotlin.Int). | | Return || |-----------------------------------------------------------------------------------------------------------------------------|---------------------------------| | [Notification.WearableExtender](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#)! | this object for method chaining | ### setHintShowBackgroundOnly Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setHintShowBackgroundOnly(hintShowBackgroundOnly: Boolean): Notification.WearableExtender! ``` **Deprecated:** *Deprecated in Java.* 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](https://developer.android.com/reference/kotlin/android/app/Notification.WearableExtender#addPage(android.app.Notification)). ### setStartScrollBottom Added in[API level 20](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setStartScrollBottom(startScrollBottom: Boolean): Notification.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).