Notification.Action.WearableExtender
public
static
final
class
Notification.Action.WearableExtender
extends Object
implements
Notification.Action.Extender
java.lang.Object | |
↳ | android.app.Notification.Action.WearableExtender |
Wearable extender for notification actions. To add extensions to an action,
create a new Notification.Action.WearableExtender
object using
the WearableExtender()
constructor and apply it to a
Notification.Action.Builder
using
Notification.Action.Builder.extend(Extender)
.
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 |
|
WearableExtender(Notification.Action action)
Create a |
Public methods | |
---|---|
Notification.Action.WearableExtender
|
clone()
Creates and returns a copy of this object. |
Notification.Action.Builder
|
extend(Notification.Action.Builder 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 |
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(boolean availableOffline)
Set whether this action is available when the wearable device is not connected to a companion device. |
Notification.Action.WearableExtender
|
setCancelLabel(CharSequence label)
Set a label to display to cancel the action. |
Notification.Action.WearableExtender
|
setConfirmLabel(CharSequence label)
Set a label to display to confirm that the action should be executed. |
Notification.Action.WearableExtender
|
setHintDisplayActionInline(boolean hintDisplayInline)
Set a hint that this Action should be displayed inline. |
Notification.Action.WearableExtender
|
setHintLaunchesActivity(boolean hintLaunchesActivity)
Set a hint that this Action will launch an |
Notification.Action.WearableExtender
|
setInProgressLabel(CharSequence label)
Set a label to display while the wearable is preparing to automatically execute the action. |
Inherited methods | |
---|---|
Public constructors
WearableExtender
public WearableExtender ()
Create a Notification.Action.WearableExtender
with default
options.
WearableExtender
public WearableExtender (Notification.Action action)
Create a 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
public Notification.Action.WearableExtender clone ()
Creates and returns a copy of this object. The precise meaning
of "copy" may depend on the class of the object. The general
intent is that, for any object x
, the expression:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true
, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
true
, this is not an absolute requirement.
By convention, the returned object should be obtained by calling
super.clone
. If a class and all of its superclasses (except
Object
) obey this convention, it will be the case that
x.clone().getClass() == x.getClass()
.
By convention, the object returned by this method should be independent
of this object (which is being cloned). To achieve this independence,
it may be necessary to modify one or more fields of the object returned
by super.clone
before returning it. Typically, this means
copying any mutable objects that comprise the internal "deep structure"
of the object being cloned and replacing the references to these
objects with references to the copies. If a class contains only
primitive fields or references to immutable objects, then it is usually
the case that no fields in the object returned by super.clone
need to be modified.
Returns | |
---|---|
Notification.Action.WearableExtender |
a clone of this instance. |
extend
public Notification.Action.Builder extend (Notification.Action.Builder builder)
Apply wearable extensions to a notification action that is being built. This is
typically called by the Notification.Action.Builder.extend(Extender)
method of Notification.Action.Builder
.
Parameters | |
---|---|
builder |
Notification.Action.Builder : the builder to be modified. |
Returns | |
---|---|
Notification.Action.Builder |
the build object for chaining. |
getCancelLabel
public CharSequence getCancelLabel ()
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 ()
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.
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 ()
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 Notification.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 | |
---|---|
Notification.Action.WearableExtender |
setCancelLabel
public Notification.Action.WearableExtender setCancelLabel (CharSequence label)
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 | |
---|---|
Notification.Action.WearableExtender |
this object for method chaining |
setConfirmLabel
public Notification.Action.WearableExtender setConfirmLabel (CharSequence label)
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 | |
---|---|
Notification.Action.WearableExtender |
this object for method chaining |
setHintDisplayActionInline
public Notification.Action.WearableExtender setHintDisplayActionInline (boolean hintDisplayInline)
Set a hint that this Action should be displayed inline.
Parameters | |
---|---|
hintDisplayInline |
boolean : true if action should be displayed inline, false
otherwise |
Returns | |
---|---|
Notification.Action.WearableExtender |
this object for method chaining |
setHintLaunchesActivity
public Notification.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 | |
---|---|
Notification.Action.WearableExtender |
this object for method chaining |
setInProgressLabel
public Notification.Action.WearableExtender setInProgressLabel (CharSequence label)
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 | |
---|---|
Notification.Action.WearableExtender |
this object for method chaining |