NotificationCompat.Action.WearableExtender
public
static
final
class
NotificationCompat.Action.WearableExtender
extends Object
implements
NotificationCompat.Action.Extender
java.lang.Object | |
↳ | 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.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 | |
---|---|
WearableExtender()
Create a |
|
WearableExtender(NotificationCompat.Action action)
Create a |
Public methods | |
---|---|
NotificationCompat.Action.WearableExtender
|
clone()
|
NotificationCompat.Action.Builder
|
extend(NotificationCompat.Action.Builder builder)
Apply wearable extensions to a notification action that is being built. |
CharSequence
|
getCancelLabel()
This method is deprecated. This method has no effect starting with Wear 2.0. |
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. |
boolean
|
getHintLaunchesActivity()
Get a hint that this Action will launch an |
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. |
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)
This method is deprecated. This method has no effect starting with Wear 2.0. |
NotificationCompat.Action.WearableExtender
|
setConfirmLabel(CharSequence label)
This method is deprecated. This method has no effect starting with Wear 2.0. |
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 |
NotificationCompat.Action.WearableExtender
|
setInProgressLabel(CharSequence label)
This method is deprecated. This method has no effect starting with Wear 2.0. |
Inherited methods | |
---|---|
Public constructors
WearableExtender
public WearableExtender ()
Create a NotificationCompat.Action.WearableExtender
with default
options.
WearableExtender
public 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
public NotificationCompat.Action.WearableExtender clone ()
Returns | |
---|---|
NotificationCompat.Action.WearableExtender |
extend
public 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 NotificationCompat.Action.Builder.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
public 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 | |
---|---|
CharSequence |
the label to display to cancel the action |
getConfirmLabel
public 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 | |
---|---|
CharSequence |
the label to confirm the action should be executed |
getHintDisplayActionInline
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
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
public 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 | |
---|---|
CharSequence |
the label to display while the action is being prepared to execute |
isAvailableOffline
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.
Returns | |
---|---|
boolean |
setAvailableOffline
public 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
public NotificationCompat.Action.WearableExtender setCancelLabel (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 | |
---|---|
label |
CharSequence : the label to display to cancel the action |
Returns | |
---|---|
NotificationCompat.Action.WearableExtender |
this object for method chaining |
setConfirmLabel
public NotificationCompat.Action.WearableExtender setConfirmLabel (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 | |
---|---|
label |
CharSequence : the label to confirm the action should be executed |
Returns | |
---|---|
NotificationCompat.Action.WearableExtender |
this object for method chaining |
setHintDisplayActionInline
public 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
public 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
public NotificationCompat.Action.WearableExtender setInProgressLabel (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 | |
---|---|
label |
CharSequence : the label to display while the action is being prepared to execute |
Returns | |
---|---|
NotificationCompat.Action.WearableExtender |
this object for method chaining |