WearableExtender

class WearableExtender : NotificationCompat.Action.Extender
kotlin.Any
   ↳ androidx.core.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 NotificationCompat.Action.Builder#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

Create a NotificationCompat.Action.WearableExtender with default options.

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

Public methods

NotificationCompat.Action.WearableExtender!

NotificationCompat.Action.Builder!

Apply wearable extensions to a notification action that is being built.

CharSequence!

Get the label to display to cancel the action.

CharSequence!

Get the label to display to confirm that the action should be executed.

Boolean

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

Boolean

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

CharSequence!

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

Boolean

Get whether this action is available when the wearable device is not connected to a companion device.

NotificationCompat.Action.WearableExtender!
setAvailableOffline(availableOffline: Boolean)

Set whether this action is available when the wearable device is not connected to a companion device.

NotificationCompat.Action.WearableExtender!

Set a label to display to cancel the action.

NotificationCompat.Action.WearableExtender!

Set a label to display to confirm that the action should be executed.

NotificationCompat.Action.WearableExtender!
setHintDisplayActionInline(hintDisplayInline: Boolean)

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

NotificationCompat.Action.WearableExtender!
setHintLaunchesActivity(hintLaunchesActivity: Boolean)

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

NotificationCompat.Action.WearableExtender!

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

Public constructors

<init>

WearableExtender()

Create a NotificationCompat.Action.WearableExtender with default options.

<init>

WearableExtender(action: NotificationCompat.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

extend

fun extend(builder: NotificationCompat.Action.Builder!): NotificationCompat.Action.Builder!

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

Parameters
builder NotificationCompat.Action.Builder!: the builder to be modified.
Return
NotificationCompat.Action.Builder!: the build object for chaining.

getCancelLabel

fun getCancelLabel(): CharSequence!

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

Return
CharSequence!: the label to display to cancel the action

getConfirmLabel

fun getConfirmLabel(): CharSequence!

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

Return
CharSequence!: the label to confirm the action should be executed

getHintDisplayActionInline

fun getHintDisplayActionInline(): Boolean

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

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

getHintLaunchesActivity

fun getHintLaunchesActivity(): Boolean

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

Return
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

fun getInProgressLabel(): CharSequence!

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

Return
CharSequence!: the label to display while the action is being prepared to execute

isAvailableOffline

fun isAvailableOffline(): Boolean

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

fun setAvailableOffline(availableOffline: Boolean): NotificationCompat.Action.WearableExtender!

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

fun setCancelLabel(label: CharSequence!): NotificationCompat.Action.WearableExtender!

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

setConfirmLabel

fun setConfirmLabel(label: CharSequence!): NotificationCompat.Action.WearableExtender!

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

setHintDisplayActionInline

fun setHintDisplayActionInline(hintDisplayInline: Boolean): NotificationCompat.Action.WearableExtender!

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
Return
NotificationCompat.Action.WearableExtender!: this object for method chaining

setHintLaunchesActivity

fun setHintLaunchesActivity(hintLaunchesActivity: Boolean): NotificationCompat.Action.WearableExtender!

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.
Return
NotificationCompat.Action.WearableExtender!: this object for method chaining

setInProgressLabel

fun setInProgressLabel(label: CharSequence!): NotificationCompat.Action.WearableExtender!

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
label CharSequence!: the label to display while the action is being prepared to execute
Return
NotificationCompat.Action.WearableExtender!: this object for method chaining