Most visited

Recently visited

Results for

Summary: Constants | Ctors | Methods | Inherited Methods | [Expand All]

NotificationCompat.WearableExtender

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

java.lang.Object
↳	android.support.v4.app.NotificationCompat.WearableExtender

Helper class to add wearable extensions to notifications.

See Creating Notifications for Android Wear for more information on how to use this class.

To create a notification with wearable extensions:

Create a NotificationCompat.Builder, setting any desired properties.
Create a NotificationCompat.WearableExtender.
Set wearable-specific properties using the add and set methods of NotificationCompat.WearableExtender.
Call extend(NotificationCompat.Extender) to apply the extensions to a notification.
Post the notification to the notification system with the NotificationManagerCompat.notify(...) methods and not the NotificationManager.notify(...) methods.

 Notification notif = new NotificationCompat.Builder(mContext)
         .setContentTitle("New mail from " + sender.toString())
         .setContentText(subject)
         .setSmallIcon(R.drawable.new_mail)
         .extend(new NotificationCompat.WearableExtender()
                 .setContentIcon(R.drawable.new_mail))
         .build();
 NotificationManagerCompat.from(mContext).notify(0, 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.

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

Summary

Constants
`int`	`SCREEN_TIMEOUT_LONG` 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.
`int`	`SCREEN_TIMEOUT_SHORT` 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.
`int`	`SIZE_DEFAULT` Size value for use with `setCustomSizePreset(int)` to show this notification with default sizing.
`int`	`SIZE_FULL_SCREEN` Size value for use with `setCustomSizePreset(int)` to show this notification full screen.
`int`	`SIZE_LARGE` Size value for use with `setCustomSizePreset(int)` to show this notification with a large size.
`int`	`SIZE_MEDIUM` Size value for use with `setCustomSizePreset(int)` to show this notification with a medium size.
`int`	`SIZE_SMALL` Size value for use with `setCustomSizePreset(int)` to show this notification with a small size.
`int`	`SIZE_XSMALL` Size value for use with `setCustomSizePreset(int)` to show this notification with an extra small size.
`int`	`UNSET_ACTION_INDEX` Sentinel value for an action index that is unset.

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

Public methods
`NotificationCompat.WearableExtender`	`addAction(NotificationCompat.Action action)` Add a wearable action to this notification.
`NotificationCompat.WearableExtender`	`addActions(List<NotificationCompat.Action> actions)` Adds wearable actions to this notification.
`NotificationCompat.WearableExtender`	`addPage(Notification page)` Add an additional page of content to display with this notification.
`NotificationCompat.WearableExtender`	`addPages(List<Notification> pages)` Add additional pages of content to display with this notification.
`NotificationCompat.WearableExtender`	`clearActions()` Clear all wearable actions present on this builder.
`NotificationCompat.WearableExtender`	`clearPages()` Clear all additional pages present on this builder.
`NotificationCompat.WearableExtender`	`clone()` Creates and returns a copy of this object.
`NotificationCompat.Builder`	`extend(NotificationCompat.Builder builder)` Apply wearable extensions to a notification that is being built.
`List<NotificationCompat.Action>`	`getActions()` Get the wearable actions present on this notification.
`Bitmap`	`getBackground()` Get a background image to be displayed behind the notification content.
`int`	`getContentAction()` Get the index of the notification action, if any, that was specified as being clickable with the content of this notification.
`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 `NotificationCompat.WearableExtender`, e.g.
`String`	`getDismissalId()` Returns the dismissal id of the notification.
`PendingIntent`	`getDisplayIntent()` Get the intent to launch inside of an activity view when displaying this notification.
`int`	`getGravity()` Get the gravity that this notification should have within the available viewport space.
`boolean`	`getHintAmbientBigPicture()` Get a hint that this notification's `NotificationCompat.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`	`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()` Get the array of additional pages of content for displaying this notification.
`boolean`	`getStartScrollBottom()` Get whether the scrolling position for the contents of this notification should start at the bottom of the contents instead of the top when the contents are too long to display within the screen.
`NotificationCompat.WearableExtender`	`setBackground(Bitmap background)` Set a background image to be displayed behind the notification content.
`NotificationCompat.WearableExtender`	`setContentAction(int actionIndex)` Set an action from this notification's actions to be clickable with the content of this notification.
`NotificationCompat.WearableExtender`	`setContentIcon(int icon)` Set an icon that goes with the content of this notification.
`NotificationCompat.WearableExtender`	`setContentIconGravity(int contentIconGravity)` Set the gravity that the content icon should have within the notification display.
`NotificationCompat.WearableExtender`	`setContentIntentAvailableOffline(boolean contentIntentAvailableOffline)` Set whether the content intent is available when the wearable device is not connected to a companion device.
`NotificationCompat.WearableExtender`	`setCustomContentHeight(int height)` Set the custom height in pixels for the display of this notification's content.
`NotificationCompat.WearableExtender`	`setCustomSizePreset(int sizePreset)` Set the custom size preset for the display of this notification out of the available presets found in `NotificationCompat.WearableExtender`, e.g.
`NotificationCompat.WearableExtender`	`setDismissalId(String dismissalId)` When you post a notification, if you set the dismissal id field, then when that notification is canceled, notifications on other wearables and the paired Android phone having that same dismissal id will also be canceled.
`NotificationCompat.WearableExtender`	`setDisplayIntent(PendingIntent intent)` Set an intent to launch inside of an activity view when displaying this notification.
`NotificationCompat.WearableExtender`	`setGravity(int gravity)` Set the gravity that this notification should have within the available viewport space.
`NotificationCompat.WearableExtender`	`setHintAmbientBigPicture(boolean hintAmbientBigPicture)` Set a hint that this notification's `NotificationCompat.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.
`NotificationCompat.WearableExtender`	`setHintAvoidBackgroundClipping(boolean hintAvoidBackgroundClipping)` Set a hint that this notification's background should not be clipped if possible, and should instead be resized to fully display on the screen, retaining the aspect ratio of the image.
`NotificationCompat.WearableExtender`	`setHintContentIntentLaunchesActivity(boolean hintContentIntentLaunchesActivity)` Set a hint that this notification's content intent will launch an `Activity` directly, telling the platform that it can generate the appropriate transitions.
`NotificationCompat.WearableExtender`	`setHintHideIcon(boolean hintHideIcon)` Set a hint that this notification's icon should not be displayed.
`NotificationCompat.WearableExtender`	`setHintScreenTimeout(int timeout)` Set a hint that the screen should remain on for at least this duration when this notification is displayed on the screen.
`NotificationCompat.WearableExtender`	`setHintShowBackgroundOnly(boolean hintShowBackgroundOnly)` Set a visual hint that only the background image of this notification should be displayed, and other semantic content should be hidden.
`NotificationCompat.WearableExtender`	`setStartScrollBottom(boolean startScrollBottom)` Set whether the scrolling position for the contents of this notification should start at the bottom of the contents instead of the top when the contents are too long to display within the screen.

Inherited methods

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 millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


  
    android.support.v4.app.NotificationCompat.Extender

Constants

SCREEN_TIMEOUT_LONG

int SCREEN_TIMEOUT_LONG

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

int SCREEN_TIMEOUT_SHORT

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

int SIZE_DEFAULT

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)