Skip to content

Most visited

Recently visited

navigation

NotificationCompat.Action.WearableExtender

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

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


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.

boolean getHintDisplayActionInline()

Get a hint that this Action should be displayed inline - i.e.

boolean getHintLaunchesActivity()

Get a hint that this Action will launch an Activity directly, telling the platform that it can generate the appropriate transitions

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 setHintDisplayActionInline(boolean hintDisplayInline)

Set a hint that this Action should be displayed inline - i.e.

NotificationCompat.Action.WearableExtender setHintLaunchesActivity(boolean hintLaunchesActivity)

Set a hint that this Action will launch an Activity directly, telling the platform that it can generate the appropriate transitions.

NotificationCompat.Action.WearableExtender setInProgressLabel(CharSequence label)

Set a label to display while the wearable is preparing to automatically execute the action.

Inherited methods

From class java.lang.Object
From interface android.support.v4.app.NotificationCompat.Action.Extender

Public constructors

NotificationCompat.Action.WearableExtender

NotificationCompat.Action.WearableExtender ()

Create a NotificationCompat.Action.WearableExtender with default options.

NotificationCompat.Action.WearableExtender

NotificationCompat.Action.WearableExtender (NotificationCompat.Action action)

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

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

Public methods

clone

NotificationCompat.Action.WearableExtender clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x
will be true, and that the expression:
 x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
 x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Returns
NotificationCompat.Action.WearableExtender a clone of this instance.

extend

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

getCancelLabel

CharSequence getCancelLabel ()

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

getConfirmLabel

CharSequence getConfirmLabel ()

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

getHintDisplayActionInline

boolean getHintDisplayActionInline ()

Get a hint that this Action should be displayed inline - i.e. it should have a visual representation directly on the notification surface in addition to the expanded Notification

Returns
boolean true if the Action should be displayed inline, false otherwise. The default value is false if this was never set.

getHintLaunchesActivity

boolean getHintLaunchesActivity ()

Get a hint that this Action will launch an Activity directly, telling the platform that it can generate the appropriate transitions

Returns
boolean 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.

getInProgressLabel

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

isAvailableOffline

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.

Returns
boolean

setAvailableOffline

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.

Parameters
availableOffline boolean
Returns
NotificationCompat.Action.WearableExtender

setCancelLabel

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 CharSequence: the label to display to cancel the action
Returns
NotificationCompat.Action.WearableExtender this object for method chaining

setConfirmLabel

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 CharSequence: the label to confirm the action should be executed
Returns
NotificationCompat.Action.WearableExtender this object for method chaining

setHintDisplayActionInline

NotificationCompat.Action.WearableExtender setHintDisplayActionInline (boolean hintDisplayInline)

Set a hint that this Action should be displayed inline - i.e. it will have a visual representation directly on the notification surface in addition to the expanded Notification

Parameters
hintDisplayInline boolean: true if action should be displayed inline, false otherwise
Returns
NotificationCompat.Action.WearableExtender this object for method chaining

setHintLaunchesActivity

NotificationCompat.Action.WearableExtender setHintLaunchesActivity (boolean hintLaunchesActivity)

Set a hint that this Action will launch an Activity directly, telling the platform that it can generate the appropriate transitions.

Parameters
hintLaunchesActivity boolean: true if the content intent will launch an activity and transitions should be generated, false otherwise.
Returns
NotificationCompat.Action.WearableExtender this object for method chaining

setInProgressLabel

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 CharSequence: the label to display while the action is being prepared to execute
Returns
NotificationCompat.Action.WearableExtender this object for method chaining
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.