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.
CharSequence getCancelLabel()
Get the label to display to cancel the action.
CharSequence getConfirmLabel()
Get the label to display to confirm that the action should be executed.
CharSequence getInProgressLabel()
Get the label to display while the wearable is preparing to automatically execute the action.
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.
Notification.Action.WearableExtender setCancelLabel(CharSequence label)
Set a label to display to cancel the action.
Notification.Action.WearableExtender setConfirmLabel(CharSequence label)
Set a label to display to confirm that the action should be executed.
Notification.Action.WearableExtender setInProgressLabel(CharSequence label)
Set a label to display while the wearable is preparing to automatically execute the action.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.app.Notification.Action.Extender

Public Constructors

public Notification.Action.WearableExtender ()

Added in API level 20

Create a Notification.Action.WearableExtender with default options.

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

Added in API level 20

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

Parameters
action Notification.Action: the notification action to inspect.

Public Methods

public Notification.Action.WearableExtender clone ()

Added in API level 20

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
Notification.Action.WearableExtender a copy of this object.

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

Added in API level 20

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 Notification.Action.Builder: the builder to be modified.
Returns
Notification.Action.Builder the build object for chaining.

public CharSequence getCancelLabel ()

Added in API level 22

Get the label to display to cancel the action. This is usually an imperative verb like "Cancel".

Returns
CharSequence the label to display to cancel the action

public CharSequence getConfirmLabel ()

Added in API level 22

Get the label to display to confirm that the action should be executed. This is usually an imperative verb like "Send".

Returns
CharSequence the label to confirm the action should be executed

public CharSequence getInProgressLabel ()

Added in API level 22

Get the label to display while the wearable is preparing to automatically execute the action. This is usually a 'ing' verb ending in ellipsis like "Sending..."

Returns
CharSequence the label to display while the action is being prepared to execute

public boolean isAvailableOffline ()

Added in API level 20

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.

Returns
boolean

public Notification.Action.WearableExtender setAvailableOffline (boolean availableOffline)

Added in API level 20

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.

Parameters
availableOffline boolean
Returns
Notification.Action.WearableExtender

public Notification.Action.WearableExtender setCancelLabel (CharSequence label)

Added in API level 22

Set a label to display to cancel the action. This is usually an imperative verb, like "Cancel".

Parameters
label CharSequence: the label to display to cancel the action
Returns
Notification.Action.WearableExtender this object for method chaining

public Notification.Action.WearableExtender setConfirmLabel (CharSequence label)

Added in API level 22

Set a label to display to confirm that the action should be executed. This is usually an imperative verb like "Send".

Parameters
label CharSequence: the label to confirm the action should be executed
Returns
Notification.Action.WearableExtender this object for method chaining

public Notification.Action.WearableExtender setInProgressLabel (CharSequence label)

Added in API level 22

Set a label to display while the wearable is preparing to automatically execute the action. This is usually a 'ing' verb ending in ellipsis like "Sending..."

Parameters
label CharSequence: the label to display while the action is being prepared to execute
Returns
Notification.Action.WearableExtender this object for method chaining