Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public static final class

Notification.Action.WearableExtender

extends Object
implements Notification.Action.Extender
java.lang.Object
   ↳ android.app.Notification.Action.WearableExtender

Class Overview

Wearable extender for notification actions. To add extensions to an action, create a new Notification.Action.WearableExtender object using the WearableExtender() constructor and apply it to a Notification.Action.Builder using extend(Notification.Action.Extender) . 

        Notification.Action action = new Notification.Action.Builder(
         R.drawable.archive_all, "Archive all", actionIntent)
         .extend(new Notification.Action.WearableExtender()
                 .setAvailableOffline(false))
         .build();

Summary

Public Constructors
Notification.Action.WearableExtender ()
Create a Notification.Action.WearableExtender with default options.
Notification.Action.WearableExtender ( Notification.Action action)
Create a Notification.Action.WearableExtender by reading wearable options present in an existing notification action.
Public Methods
Notification.Action.WearableExtender clone ()
Creates and returns a copy of this Object .
Notification.Action.Builder extend ( Notification.Action.Builder builder)
Apply wearable extensions to a notification action that is being built.
boolean isAvailableOffline ()
Get whether this action is available when the wearable device is not connected to a companion device.
Notification.Action.WearableExtender setAvailableOffline (boolean availableOffline)
Set whether this action is available when the wearable device is not connected to a companion device.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.app.Notification.Action.Extender

Public Constructors

public Notification.Action.WearableExtender ()

Create a Notification.Action.WearableExtender with default options.

public Notification.Action.WearableExtender ( Notification.Action action)

Create a Notification.Action.WearableExtender by reading wearable options present in an existing notification action.

Parameters
action the notification action to inspect.

Public Methods

public Notification.Action.WearableExtender clone ()

Creates and returns a copy of this Object . The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects.

Returns
  • a copy of this object.

public Notification.Action.Builder extend ( Notification.Action.Builder builder)

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

Parameters
builder the builder to be modified.
Returns
  • the build object for chaining.

public boolean isAvailableOffline ()

Get whether this action is available when the wearable device is not connected to a companion device. The user can still trigger this action when the wearable device is offline, but a visual hint will indicate that the action may not be available. Defaults to true.

public Notification.Action.WearableExtender setAvailableOffline (boolean availableOffline)

Set whether this action is available when the wearable device is not connected to a companion device. The user can still trigger this action when the wearable device is offline, but a visual hint will indicate that the action may not be available. Defaults to true.