WearableExtender

Kotlin |Java

class WearableExtender : Notification.Action.Extender

kotlin.Any
↳	android.app.Notification.Action.WearableExtender

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

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
`WearableExtender()` Create a `android.app.Notification.Action.WearableExtender` with default options.
`WearableExtender(action: Notification.Action!)` Create a `android.app.Notification.Action.WearableExtender` by reading wearable options present in an existing notification action.

Public methods
Notification.Action.WearableExtender!	`clone()`
Notification.Action.Builder!	`extend(builder: Notification.Action.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.
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.
Notification.Action.WearableExtender!	`setAvailableOffline(availableOffline: Boolean)` Set whether this action is available when the wearable device is not connected to a companion device.
Notification.Action.WearableExtender!	`setCancelLabel(label: CharSequence!)` Set a label to display to cancel the action.
Notification.Action.WearableExtender!	`setConfirmLabel(label: CharSequence!)` Set a label to display to confirm that the action should be executed.
Notification.Action.WearableExtender!	`setHintDisplayActionInline(hintDisplayInline: Boolean)` Set a hint that this Action should be displayed inline.
Notification.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.
Notification.Action.WearableExtender!	`setInProgressLabel(label: CharSequence!)` Set a label to display while the wearable is preparing to automatically execute the action.

Public constructors

WearableExtender

Added in API level 20

WearableExtender()

Create a android.app.Notification.Action.WearableExtender with default options.

WearableExtender

Added in API level 20

WearableExtender(action: Notification.Action!)

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

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

Public methods

clone

Added in API level 20

fun clone(): Notification.Action.WearableExtender!

Return
`Notification.Action.WearableExtender!`	a clone of this instance.

Exceptions
`java.lang.CloneNotSupportedException`	if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

extend

Added in API level 20

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

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

Parameters
`builder`	Notification.Action.Builder!: the builder to be modified.

Return
`Notification.Action.Builder!`	the build object for chaining.

getCancelLabel

Added in API level 22
Deprecated in API level 28

fun getCancelLabel(): CharSequence!

Deprecated: Deprecated in Java.

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

Added in API level 22
Deprecated in API level 28

fun getConfirmLabel(): CharSequence!

Deprecated: Deprecated in Java.

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

Added in API level 25

fun getHintDisplayActionInline(): Boolean

Get a hint that this Action should be displayed inline.

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

getHintLaunchesActivity

Added in API level 24

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

Added in API level 22
Deprecated in API level 28

fun getInProgressLabel(): CharSequence!

Deprecated: Deprecated in Java.

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

Added in API level 20

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

Added in API level 20

fun setAvailableOffline(availableOffline: Boolean): Notification.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

Added in API level 22
Deprecated in API level 28

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

Deprecated: Deprecated in Java.

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
`Notification.Action.WearableExtender!`	this object for method chaining

setConfirmLabel

Added in API level 22
Deprecated in API level 28

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

Deprecated: Deprecated in Java.

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
`Notification.Action.WearableExtender!`	this object for method chaining

setHintDisplayActionInline

Added in API level 25

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

Set a hint that this Action should be displayed inline.

Parameters
`hintDisplayInline`	Boolean: `true` if action should be displayed inline, false otherwise

Return
`Notification.Action.WearableExtender!`	this object for method chaining

setHintLaunchesActivity

Added in API level 24

fun setHintLaunchesActivity(hintLaunchesActivity: Boolean): Notification.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
`Notification.Action.WearableExtender!`	this object for method chaining

setInProgressLabel

Added in API level 22
Deprecated in API level 28

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

Deprecated: Deprecated in Java.

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
`Notification.Action.WearableExtender!`	this object for method chaining