belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1
NotificationCompat.Action.WearableExtender
public
static
final
class
NotificationCompat.Action.WearableExtender
extends Object
implements
NotificationCompat.Action.Extender
java.lang.Object | |
↳ | android.support.v4.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
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 | |
---|---|
NotificationCompat.Action.WearableExtender()
Create a |
|
NotificationCompat.Action.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()
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 - i.e. |
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. |
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)
Set a label to display to cancel the action. |
NotificationCompat.Action.WearableExtender
|
setConfirmLabel(CharSequence label)
Set a label to display to confirm that the action should be executed. |
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)
Set a label to display while the wearable is preparing to automatically execute the action. |
Inherited methods | |
---|---|
From
class
java.lang.Object
| |
From
interface
android.support.v4.app.NotificationCompat.Action.Extender
|
Public constructors
NotificationCompat.Action.WearableExtender
NotificationCompat.Action.WearableExtender ()
Create a NotificationCompat.Action.WearableExtender
with default
options.
NotificationCompat.Action.WearableExtender
NotificationCompat.Action.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
NotificationCompat.Action.WearableExtender clone ()
Returns | |
---|---|
NotificationCompat.Action.WearableExtender |
extend
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 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
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
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
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
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
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
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
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
NotificationCompat.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 | |
---|---|
NotificationCompat.Action.WearableExtender |
this object for method chaining |
setConfirmLabel
NotificationCompat.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 | |
---|---|
NotificationCompat.Action.WearableExtender |
this object for method chaining |
setHintDisplayActionInline
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
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
NotificationCompat.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 | |
---|---|
NotificationCompat.Action.WearableExtender |
this object for method chaining |
Annotations
Interfaces
- ActionBarDrawerToggle.Delegate
- ActionBarDrawerToggle.DelegateProvider
- ActivityCompat.OnRequestPermissionsResultCallback
- ActivityCompat.PermissionCompatDelegate
- FragmentManager.BackStackEntry
- FragmentManager.OnBackStackChangedListener
- LoaderManager.LoaderCallbacks
- NotificationCompat.Action.Extender
- NotificationCompat.Extender
- SharedElementCallback.OnSharedElementsReadyListener
- TaskStackBuilder.SupportParentable
Classes
- ActionBarDrawerToggle
- ActivityCompat
- ActivityManagerCompat
- ActivityOptionsCompat
- AlarmManagerCompat
- AppLaunchChecker
- AppOpsManagerCompat
- BundleCompat
- DialogFragment
- Fragment
- Fragment.SavedState
- FragmentActivity
- FragmentContainer
- FragmentController
- FragmentHostCallback
- FragmentManager
- FragmentManager.FragmentLifecycleCallbacks
- FragmentManagerNonConfig
- FragmentPagerAdapter
- FragmentStatePagerAdapter
- FragmentTabHost
- FragmentTransaction
- FrameMetricsAggregator
- JobIntentService
- ListFragment
- LoaderManager
- NavUtils
- NotificationCompat
- NotificationCompat.Action
- NotificationCompat.Action.Builder
- NotificationCompat.Action.WearableExtender
- NotificationCompat.BigPictureStyle
- NotificationCompat.BigTextStyle
- NotificationCompat.Builder
- NotificationCompat.CarExtender
- NotificationCompat.CarExtender.UnreadConversation
- NotificationCompat.CarExtender.UnreadConversation.Builder
- NotificationCompat.DecoratedCustomViewStyle
- NotificationCompat.InboxStyle
- NotificationCompat.MessagingStyle
- NotificationCompat.MessagingStyle.Message
- NotificationCompat.Style
- NotificationCompat.WearableExtender
- NotificationCompatExtras
- NotificationCompatSideChannelService
- NotificationManagerCompat
- RemoteInput
- RemoteInput.Builder
- ServiceCompat
- ShareCompat
- ShareCompat.IntentBuilder
- ShareCompat.IntentReader
- SharedElementCallback
- TaskStackBuilder
Exceptions