NotificationCompat.Action.WearableExtender

Added in 1.1.0

Kotlin |Java

class NotificationCompat.Action.WearableExtender : 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(action: NotificationCompat.Action)` Create a `NotificationCompat.Action.WearableExtender` by reading wearable options present in an existing notification action.

Public functions
`NotificationCompat.Action.WearableExtender`	`clone()`
`NotificationCompat.Action.Builder`	`extend(builder: NotificationCompat.Action.Builder)` Apply wearable extensions to a notification action that is being built.
`CharSequence?`	`getCancelLabel()` This function is deprecated. This method has no effect starting with Wear 2.0.
`CharSequence?`	`getConfirmLabel()` This function 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
`CharSequence?`	`getInProgressLabel()` This function 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.
`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`	`setCancelLabel(label: CharSequence?)` This function is deprecated. This method has no effect starting with Wear 2.0.
`NotificationCompat.Action.WearableExtender`	`setConfirmLabel(label: CharSequence?)` This function is deprecated. This method has no effect starting with Wear 2.0.
`NotificationCompat.Action.WearableExtender`	`setHintDisplayActionInline(hintDisplayInline: Boolean)` 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
`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`	`setInProgressLabel(label: CharSequence?)` This function is deprecated. This method has no effect starting with Wear 2.0.

Public constructors

WearableExtender

Added in 1.1.0

WearableExtender()

Create a NotificationCompat.Action.WearableExtender with default options.

WearableExtender

Added in 1.1.0

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 functions

clone

Added in 1.1.0

fun clone(): NotificationCompat.Action.WearableExtender

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 extend method of NotificationCompat.Action.Builder.

getCancelLabel

Added in 1.1.0

Deprecated in 1.1.0

fun getCancelLabel(): CharSequence?

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

Added in 1.1.0

Deprecated in 1.1.0

fun getConfirmLabel(): CharSequence?

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

Added in 1.1.0

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

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

fun getHintLaunchesActivity(): Boolean

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

fun getInProgressLabel(): CharSequence?

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

Added in 1.1.0

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 1.1.0

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

Added in 1.1.0

Deprecated in 1.1.0

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

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

Added in 1.1.0

Deprecated in 1.1.0

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

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

Added in 1.1.0

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

Returns
`NotificationCompat.Action.WearableExtender`	this object for method chaining

setHintLaunchesActivity

Added in 1.1.0

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.

Returns
`NotificationCompat.Action.WearableExtender`	this object for method chaining

setInProgressLabel

Added in 1.1.0

Deprecated in 1.1.0

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

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