Android APIs
public static final class

NotificationCompat.Action.WearableExtender

extends Object
implements NotificationCompat.Action.Extender
java.lang.Object
   ↳ android.support.v4.app.NotificationCompat.Action.WearableExtender

Class Overview

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

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

Summary

Public Constructors
NotificationCompat.Action.WearableExtender()
Create a NotificationCompat.Action.WearableExtender with default options.
NotificationCompat.Action.WearableExtender(NotificationCompat.Action action)
Create a NotificationCompat.Action.WearableExtender by reading wearable options present in an existing notification action.
Public Methods
NotificationCompat.Action.WearableExtender clone()
Creates and returns a copy of this Object.
NotificationCompat.Action.Builder extend(NotificationCompat.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.
NotificationCompat.Action.WearableExtender setAvailableOffline(boolean availableOffline)
Set whether this action is available when the wearable device is not connected to a companion device.
NotificationCompat.Action.WearableExtender setCancelLabel(CharSequence label)
Set a label to display to cancel the action.
NotificationCompat.Action.WearableExtender setConfirmLabel(CharSequence label)
Set a label to display to confirm that the action should be executed.
NotificationCompat.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.support.v4.app.NotificationCompat.Action.Extender

Public Constructors

public NotificationCompat.Action.WearableExtender ()

Create a NotificationCompat.Action.WearableExtender with default options.

public NotificationCompat.Action.WearableExtender (NotificationCompat.Action action)

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

Parameters
action the notification action to inspect.

Public Methods

public NotificationCompat.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 NotificationCompat.Action.Builder extend (NotificationCompat.Action.Builder builder)

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

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

public CharSequence getCancelLabel ()

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

Returns
  • the label to display to cancel the action

public CharSequence getConfirmLabel ()

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

Returns
  • the label to confirm the action should be executed

public CharSequence getInProgressLabel ()

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
  • the label to display while the action is being prepared to execute

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

public NotificationCompat.Action.WearableExtender setCancelLabel (CharSequence label)

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

Parameters
label the label to display to cancel the action
Returns
  • this object for method chaining

public NotificationCompat.Action.WearableExtender setConfirmLabel (CharSequence label)

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

Parameters
label the label to confirm the action should be executed
Returns
  • this object for method chaining

public NotificationCompat.Action.WearableExtender setInProgressLabel (CharSequence label)

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 the label to display while the action is being prepared to execute
Returns
  • this object for method chaining