NotificationCompat.Action.WearableExtender

Artifact: androidx.core:core

View Source

Added in 1.1.0

---

Kotlin |Java

public final class NotificationCompat.Action.WearableExtender implements NotificationCompat.Action.Extender

---

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 action = new NotificationCompat.Action.Builder(
        R.drawable.archive_all, "Archive all", actionIntent)
        .extend(new NotificationCompat.Action.WearableExtender()
                .setAvailableOffline(false))
.build();

Summary

Public constructors
WearableExtender() Create a NotificationCompat.Action.WearableExtender with default options.
WearableExtender(@NonNull NotificationCompat.Action action) Create a NotificationCompat.Action.WearableExtender by reading wearable options present in an existing notification action.

Public methods
@NonNull NotificationCompat.Action.WearableExtender	clone()
@NonNull NotificationCompat.Action.Builder	extend(@NonNull NotificationCompat.Action.Builder builder) Apply wearable extensions to a notification action that is being built.
@Nullable CharSequence	getCancelLabel() This method is deprecated. This method has no effect starting with Wear 2.0.
@Nullable CharSequence	getConfirmLabel() This method is deprecated. This method has no effect starting with Wear 2.0.
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
boolean	getHintLaunchesActivity() Get a hint that this Action will launch an Activity directly, telling the platform that it can generate the appropriate transitions
@Nullable CharSequence	getInProgressLabel() This method is deprecated. This method has no effect starting with Wear 2.0.
boolean	isAvailableOffline() Get whether this action is available when the wearable device is not connected to a companion device.
@NonNull NotificationCompat.Action.WearableExtender	setAvailableOffline(boolean availableOffline) Set whether this action is available when the wearable device is not connected to a companion device.
@NonNull NotificationCompat.Action.WearableExtender	setCancelLabel(@Nullable CharSequence label) This method is deprecated. This method has no effect starting with Wear 2.0.
@NonNull NotificationCompat.Action.WearableExtender	setConfirmLabel(@Nullable CharSequence label) This method is deprecated. This method has no effect starting with Wear 2.0.
@NonNull 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
@NonNull 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.
@NonNull NotificationCompat.Action.WearableExtender	setInProgressLabel(@Nullable CharSequence label) This method is deprecated. This method has no effect starting with Wear 2.0.

Public constructors

WearableExtender

Added in 1.1.0

public WearableExtender()

Create a NotificationCompat.Action.WearableExtender with default options.

WearableExtender

Added in 1.1.0

public WearableExtender(@NonNull NotificationCompat.Action action)

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

Parameters
@NonNull NotificationCompat.Action action	the notification action to inspect.

Public methods

clone

Added in 1.1.0

public @NonNull NotificationCompat.Action.WearableExtender clone()

extend

Added in 1.15.0

public @NonNull NotificationCompat.Action.Builder extend(@NonNull NotificationCompat.Action.Builder builder)

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

getCancelLabel

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable CharSequence getCancelLabel()

This method is deprecated.

This method has no effect starting with Wear 2.0.

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

Returns
@Nullable CharSequence	the label to display to cancel the action

getConfirmLabel

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable CharSequence getConfirmLabel()

This method is deprecated.

This method has no effect starting with Wear 2.0.

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

Returns
@Nullable CharSequence	the label to confirm the action should be executed

getHintDisplayActionInline

Added in 1.1.0

public 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

Added in 1.1.0

public 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

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable CharSequence getInProgressLabel()

This method is deprecated.

This method has no effect starting with Wear 2.0.

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

isAvailableOffline

Added in 1.1.0

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.

setAvailableOffline

Added in 1.1.0

public @NonNull 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.

setCancelLabel

Added in 1.1.0

Deprecated in 1.1.0

public @NonNull NotificationCompat.Action.WearableExtender setCancelLabel(@Nullable CharSequence label)

This method is deprecated.

This method has no effect starting with Wear 2.0.

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

Parameters
@Nullable CharSequence label	the label to display to cancel the action

Returns
@NonNull NotificationCompat.Action.WearableExtender	this object for method chaining

setConfirmLabel

Added in 1.1.0

Deprecated in 1.1.0

public @NonNull NotificationCompat.Action.WearableExtender setConfirmLabel(@Nullable CharSequence label)

This method is deprecated.

This method has no effect starting with Wear 2.0.

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

Parameters
@Nullable CharSequence label	the label to confirm the action should be executed

Returns
@NonNull NotificationCompat.Action.WearableExtender	this object for method chaining

setHintDisplayActionInline

Added in 1.1.0

public @NonNull 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
boolean hintDisplayInline	true if action should be displayed inline, false otherwise

Returns
@NonNull NotificationCompat.Action.WearableExtender	this object for method chaining

setHintLaunchesActivity

Added in 1.1.0

public @NonNull 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
boolean hintLaunchesActivity	true if the content intent will launch an activity and transitions should be generated, false otherwise.

Returns
@NonNull NotificationCompat.Action.WearableExtender	this object for method chaining

setInProgressLabel

Added in 1.1.0

Deprecated in 1.1.0

public @NonNull NotificationCompat.Action.WearableExtender setInProgressLabel(@Nullable CharSequence label)

This method is deprecated.

This method has no effect starting with Wear 2.0.

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

Returns
@NonNull NotificationCompat.Action.WearableExtender	this object for method chaining