From 76110e7c46297a221d8f2c92fbaef46b6f405294 Mon Sep 17 00:00:00 2001 From: Joe Fernandez Date: Mon, 12 Jan 2015 10:28:03 -0800 Subject: docs: Remove Wear preview reference docs These docs are out of date and unreachable due to redirect rules. Change-Id: I76d9ccfff139b2377c45d71af2998a99b82a2f14 --- .../android/preview/support/package-summary.html | 481 ---- .../support/v4/app/NotificationManagerCompat.html | 1340 ------------ .../notifications/RemoteInput.Builder.html | 1152 ---------- .../wearable/notifications/RemoteInput.html | 1314 ----------- .../WearableNotifications.Action.Builder.html | 1087 --------- .../WearableNotifications.Action.html | 1071 --------- .../WearableNotifications.Builder.html | 1862 ---------------- .../notifications/WearableNotifications.html | 2295 -------------------- 8 files changed, 10602 deletions(-) delete mode 100644 docs/html/reference/android/preview/support/package-summary.html delete mode 100644 docs/html/reference/android/preview/support/v4/app/NotificationManagerCompat.html delete mode 100644 docs/html/reference/android/preview/support/wearable/notifications/RemoteInput.Builder.html delete mode 100644 docs/html/reference/android/preview/support/wearable/notifications/RemoteInput.html delete mode 100644 docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.Builder.html delete mode 100644 docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html delete mode 100644 docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Builder.html delete mode 100644 docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.html (limited to 'docs/html/reference/android') diff --git a/docs/html/reference/android/preview/support/package-summary.html b/docs/html/reference/android/preview/support/package-summary.html deleted file mode 100644 index 2f50871..0000000 --- a/docs/html/reference/android/preview/support/package-summary.html +++ /dev/null @@ -1,481 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Preview Notifications Reference | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
- - - - - - -
- -
-
- - - - -
-
- - -
- -
- - - - - - -

android.preview.support.v4.app

-
- - - - - - -
NotificationManagerCompatCompatibility library for NotificationManager with fallbacks for older platforms. 
-
- - - - -

android.preview.support.wearable.notifications

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
RemoteInputA RemoteInput specifies a response to be collected from the user as part of an intent being - sent. 
RemoteInput.BuilderBuilder class for RemoteInput objects. 
WearableNotificationsHelper providing extensions to android notifications for use with wearable devices. 
WearableNotifications.ActionSubclass of NotificationCompat.Action which adds support for additional - wearable extensions. 
WearableNotifications.Action.BuilderBuilder class for WearableNotifications.Action objects. 
WearableNotifications.BuilderBuilder object that wraps a NotificationCompat.Builder to provide - methods for adding wearable extensions to a notification. 
-
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/android/preview/support/v4/app/NotificationManagerCompat.html b/docs/html/reference/android/preview/support/v4/app/NotificationManagerCompat.html deleted file mode 100644 index 8322ab2..0000000 --- a/docs/html/reference/android/preview/support/v4/app/NotificationManagerCompat.html +++ /dev/null @@ -1,1340 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NotificationManagerCompat | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

NotificationManagerCompat

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.preview.support.v4.app.NotificationManagerCompat
- - - - - - - -
- - -

Class Overview

-

Compatibility library for NotificationManager with fallbacks for older platforms. - -

To use this class, call the static function from(Context) to get a - NotificationManagerCompat object, and then call one of its - methods to post or cancel notifications. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringACTION_BIND_SIDE_CHANNELIntent action to register for on a service to receive side channel - notifications.
StringEXTRA_USE_SIDE_CHANNELNotification extras key: if set to true, the posted notification should use - the side channel for delivery instead of using notification manager.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - cancel(int id) - -
Cancel a previously shown notification.
- -
- - - - - - void - - cancel(String tag, int id) - -
Cancel a previously shown notification.
- -
- - - - - - void - - cancelAll() - -
Cancel all previously shown notifications.
- -
- - - - static - - NotificationManagerCompat - - from(Context context) - -
Get a NotificationManagerCompat instance for a provided context.
- -
- - - - static - - Set<String> - - getEnabledListenerPackages(Context context) - -
Get the list of packages that have an enabled notification listener component within them, - with caching for performance.
- -
- - - - - - void - - notify(int id, Notification notification) - -
Post a notification to be shown in the status bar, stream, etc.
- -
- - - - - - void - - notify(String tag, int id, Notification notification) - -
Post a notification to be shown in the status bar, stream, etc.
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ACTION_BIND_SIDE_CHANNEL -

-
- - - - -
-
- -

Intent action to register for on a service to receive side channel - notifications. The listening service must be in the same package as an enabled - ERROR(/android.service.notification.NotificationListenerService). -

- - -
- Constant Value: - - - "android.support.app.notification.BIND_SIDE_CHANNEL" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_USE_SIDE_CHANNEL -

-
- - - - -
-
- -

Notification extras key: if set to true, the posted notification should use - the side channel for delivery instead of using notification manager. -

- - -
- Constant Value: - - - "android.preview.support.useSideChannel" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - cancel - (int id) -

-
-
- - - -
-
- -

Cancel a previously shown notification.

-
-
Parameters
- - - - -
id - the ID of the notification -
-
- -
-
- - - - -
-

- - public - - - - - void - - cancel - (String tag, int id) -

-
-
- - - -
-
- -

Cancel a previously shown notification.

-
-
Parameters
- - - - - - - -
tag - the string identifier of the notification.
id - the ID of the notification -
-
- -
-
- - - - -
-

- - public - - - - - void - - cancelAll - () -

-
-
- - - -
-
- -

Cancel all previously shown notifications.

- -
-
- - - - -
-

- - public - static - - - - NotificationManagerCompat - - from - (Context context) -

-
-
- - - -
-
- -

Get a NotificationManagerCompat instance for a provided context.

- -
-
- - - - -
-

- - public - static - - - - Set<String> - - getEnabledListenerPackages - (Context context) -

-
-
- - - -
-
- -

Get the list of packages that have an enabled notification listener component within them, - with caching for performance. -

- -
-
- - - - -
-

- - public - - - - - void - - notify - (int id, Notification notification) -

-
-
- - - -
-
- -

Post a notification to be shown in the status bar, stream, etc.

-
-
Parameters
- - - - - - - -
id - the ID of the notification
notification - the notification to post to the system -
-
- -
-
- - - - -
-

- - public - - - - - void - - notify - (String tag, int id, Notification notification) -

-
-
- - - -
-
- -

Post a notification to be shown in the status bar, stream, etc.

-
-
Parameters
- - - - - - - - - - -
tag - the string identifier for a notification. Can be null.
id - the ID of the notification. The pair (tag, id) must be unique within your app.
notification - the notification to post to the system -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/android/preview/support/wearable/notifications/RemoteInput.Builder.html b/docs/html/reference/android/preview/support/wearable/notifications/RemoteInput.Builder.html deleted file mode 100644 index 77807e4..0000000 --- a/docs/html/reference/android/preview/support/wearable/notifications/RemoteInput.Builder.html +++ /dev/null @@ -1,1152 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RemoteInput.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

RemoteInput.Builder

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.preview.support.wearable.notifications.RemoteInput.Builder
- - - - - - - -
- - -

Class Overview

-

Builder class for RemoteInput objects. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - RemoteInput.Builder(String returnKey) - -
Create a builder object for RemoteInput objects.
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - RemoteInput - - build() - -
Combine all of the options that have been set and return a new RemoteInput - object.
- -
- - - - - - RemoteInput.Builder - - setAllowFreeFormInput(boolean allowFreeFormInput) - -
Specifies whether the user can provide arbitrary values.
- -
- - - - - - RemoteInput.Builder - - setChoices(String[] choices) - -
Specifies choices available to the user to satisfy this input.
- -
- - - - - - RemoteInput.Builder - - setLabel(String label) - -
Set a label to be displayed to the user when collecting this input.
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - RemoteInput.Builder - (String returnKey) -

-
-
- - - -
-
- -

Create a builder object for RemoteInput objects.

-
-
Parameters
- - - - -
returnKey - the intent extras key that refers to the input collected from the user
-
-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - RemoteInput - - build - () -

-
-
- - - -
-
- -

Combine all of the options that have been set and return a new RemoteInput - object. -

- -
-
- - - - -
-

- - public - - - - - RemoteInput.Builder - - setAllowFreeFormInput - (boolean allowFreeFormInput) -

-
-
- - - -
-
- -

Specifies whether the user can provide arbitrary values.

-
-
Parameters
- - - - -
allowFreeFormInput - The default is true. - If you specify false, you must - provide a non-null and non-empty array to setChoices(String[]) or - an IllegalArgumentException is thrown.
-
-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - -
-

- - public - - - - - RemoteInput.Builder - - setChoices - (String[] choices) -

-
-
- - - -
-
- -

Specifies choices available to the user to satisfy this input.

-
-
Parameters
- - - - -
choices - an array of pre-defined choices for users input. - You must provide a non-null and non-empty array if - you set allowFreeFormInput to false.
-
-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - -
-

- - public - - - - - RemoteInput.Builder - - setLabel - (String label) -

-
-
- - - -
-
- -

Set a label to be displayed to the user when collecting this input.

-
-
Parameters
- - - - -
label - The label to show to users when they input a response.
-
-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/android/preview/support/wearable/notifications/RemoteInput.html b/docs/html/reference/android/preview/support/wearable/notifications/RemoteInput.html deleted file mode 100644 index 43fd36e..0000000 --- a/docs/html/reference/android/preview/support/wearable/notifications/RemoteInput.html +++ /dev/null @@ -1,1314 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RemoteInput | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

RemoteInput

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.preview.support.wearable.notifications.RemoteInput
- - - - - - - -
- - -

Class Overview

-

A RemoteInput object collects a response from users and sets the - response as an intent extra inside the PendingIntent that is sent. - Always use RemoteInput.Builder to create instances of this class. -

See - Receiving Voice Input from - a Notification for more information on how to use this class. - -

The following example adds a RemoteInput to a WearableNotifications.Action, - sets the intent extra key as quick_reply, and sets the label as Quick Reply. - Users are prompted to input a response when they trigger the action. The results are sent as an - intent extra with the key of returnKey in the action's - PendingIntent. - - 

- public static final String EXTRA_QUICK_REPLY_TEXT = "quick_reply";
- WearableNotifications.Action action = new WearableNotifications.Action.Builder(
-         R.drawable.reply, "Reply", actionIntent)
-         .addRemoteInput(new RemoteInput.Builder(EXTRA_QUICK_REPLY_TEXT)
-                 .setLabel("Quick reply").build())
-         .build();
- -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classRemoteInput.BuilderBuilder class for RemoteInput objects. 
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<RemoteInput>CREATOR
- public - - final - booleanallowFreeFormInputIndicates whether or not users can provide an arbitrary value for - input.
- public - - final - String[]choicesPossible input choices.
- public - - final - StringlabelThe label to display to users when collecting this input.
- public - - final - StringreturnKeyThe lookup key for the intent extra that the response is set in.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<RemoteInput> - - CREATOR -

-
- - - - -
-
- -

- - -
-
- - - - - -
-

- - public - - final - boolean - - allowFreeFormInput -

-
- - - - -
-
- -

Indicates whether or not users can provide an arbitrary value for - input. If you set this to false, users must select one of the - provided choices. An IllegalArgumentException is thrown - if you set this to false and choices is null or empty. -

- - -
-
- - - - - -
-

- - public - - final - String[] - - choices -

-
- - - - -
-
- -

Possible input choices. This can be null - if there are no choices to present. -

- - -
-
- - - - - -
-

- - public - - final - String - - label -

-
- - - - -
-
- -

The label to display to users when collecting this input. -

- - -
-
- - - - - -
-

- - public - - final - String - - returnKey -

-
- - - - -
-
- -

The lookup key for the intent extra that the response is set in. This is populated - when the PendingIntent is sent. -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.Builder.html b/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.Builder.html deleted file mode 100644 index 9592e27..0000000 --- a/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.Builder.html +++ /dev/null @@ -1,1087 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WearableNotifications.Action.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

WearableNotifications.Action.Builder

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.preview.support.wearable.notifications.WearableNotifications.Action.Builder
- - - - - - - -
- - -

Class Overview

-

Builder class for WearableNotifications.Action objects. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - WearableNotifications.Action.Builder(int icon, CharSequence title, PendingIntent intent) - -
Construct a new builder for WearableNotifications.Action object.
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - WearableNotifications.Action.Builder - - addRemoteInput(RemoteInput remoteInput) - -
Add an input to be collected from the user when this action is sent.
- -
- - - - - - WearableNotifications.Action - - build() - -
Combine all of the options that have been set and return a new WearableNotifications.Action - object.
- -
- - - - - - Bundle - - getExtras() - -
Get the current metadata Bundle used by this Builder, creating a new one - as necessary.
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - WearableNotifications.Action.Builder - (int icon, CharSequence title, PendingIntent intent) -

-
-
- - - -
-
- -

Construct a new builder for WearableNotifications.Action object.

-
-
Parameters
- - - - - - - - - - -
icon - icon to show for this action
title - the title of the action
intent - the PendingIntent to fire when users trigger this action -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - WearableNotifications.Action.Builder - - addRemoteInput - (RemoteInput remoteInput) -

-
-
- - - -
-
- -

Add an input to be collected from the user when this action is sent. - Response values are sent as extras to this action's pending intent when - sent.

-
-
Parameters
- - - - -
remoteInput - a RemoteInput to add to the action
-
-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - -
-

- - public - - - - - WearableNotifications.Action - - build - () -

-
-
- - - -
-
- -

Combine all of the options that have been set and return a new WearableNotifications.Action - object.

-
-
Returns
-
  • the built action -
-
- -
-
- - - - -
-

- - public - - - - - Bundle - - getExtras - () -

-
-
- - - -
-
- -

Get the current metadata Bundle used by this Builder, creating a new one - as necessary. - -

The returned Bundle is shared with this Builder. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html b/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html deleted file mode 100644 index 8073fa8..0000000 --- a/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html +++ /dev/null @@ -1,1071 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WearableNotifications.Action | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - | Fields - - - - | Inherited Fields - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

WearableNotifications.Action

- - - - - - - - - extends NotificationCompat.Action
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.support.v4.app.NotificationCompat.Action
    ↳android.preview.support.wearable.notifications.WearableNotifications.Action
- - - - - - - -
- - -

Class Overview

-

Subclass of NotificationCompat.Action that adds additional - wearable extensions for actions. -

Always use the WearableNotifications.Action.Builder to build instances of this class and call - addAction(WearableNotifications.Action) to add the action to a notification. - - 

- WearableNotifications.Builder builder = new WearableNotifications.Builder(mContext)
-         .addAction(new WearableNotifications.Action.Builder(
-                 R.drawable.navigate, "Navigate", pendingIntent)
-                 .build())
-         .setLocalOnly(true);
- Notification notif = builder.build();
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classWearableNotifications.Action.BuilderBuilder class for WearableNotifications.Action objects. 
- - - - - - - - - - - -
Fields
- public - - final - Bundleextras
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From class -android.support.v4.app.NotificationCompat.Action -
- - -
-
- - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - RemoteInput[] - - getRemoteInputs() - -
Get a list of inputs to be collected from the user when this action is sent.
- -
- - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - Bundle - - extras -

-
- - - - -
-
- -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - RemoteInput[] - - getRemoteInputs - () -

-
-
- - - -
-
- -

Get a list of inputs to be collected from the user when this action is sent.

-
-
Returns
-
  • the array of RemoteInput objects associated with this action -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Builder.html b/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Builder.html deleted file mode 100644 index 15d3303..0000000 --- a/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Builder.html +++ /dev/null @@ -1,1862 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WearableNotifications.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

WearableNotifications.Builder

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.preview.support.wearable.notifications.WearableNotifications.Builder
- - - - - - - -
- - -

Class Overview

-

Builder class that wraps a NotificationCompat.Builder to add - wearable extensions for a notification. - -

You can chain the "set" methods for this builder in any order, - but you must call the build() method last to build the final notification. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - WearableNotifications.Builder(Context context) - -
Construct a builder to be used for adding wearable extensions to notifications.
- -
- - - - - - - - WearableNotifications.Builder(NotificationCompat.Builder builder) - -
Construct a builder to be used for adding wearable extensions to notifications to - a NotificationCompat.Builder.
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - WearableNotifications.Builder - - addAction(WearableNotifications.Action action) - -
Add an action to this notification.
- -
- - - - - - WearableNotifications.Builder - - addPage(Notification page) - -
Add an additional page of content to display with this notification.
- -
- - - - - - WearableNotifications.Builder - - addPages(Collection<Notification> pages) - -
Add additional pages of content to display with this notification.
- -
- - - - - - WearableNotifications.Builder - - addRemoteInputForContentIntent(RemoteInput input) - -
Adds a RemoteInput for the content intent.
- -
- - - - - - Notification - - build() - -
Combine all of the options that have been set by both this builder and - the wrapped NotificationCompat.Builder object and return a new - Notification object.
- -
- - - - - - NotificationCompat.Builder - - getCompatBuilder() - -
Return the NotificationCompat.Builder being wrapped by this object.
- -
- - - - - - Bundle - - getExtras() - -
Get the current metadata Bundle used by this Builder, creating a new one - as necessary.
- -
- - - - - - WearableNotifications.Builder - - setBigActionIcon(int icon, CharSequence subtext) - -
Add a big action display to this notification.
- -
- - - - - - WearableNotifications.Builder - - setBigActionIcon(int icon) - -
Add a big action display to this notification.
- -
- - - - - - WearableNotifications.Builder - - setGroup(String groupKey, int groupOrder) - -
Set this notification to be part of a group of notifications sharing the same key.
- -
- - - - - - WearableNotifications.Builder - - setGroup(String groupKey) - -
Set this notification to be part of a group of notifications sharing the same key.
- -
- - - - - - WearableNotifications.Builder - - setHintHideIcon(boolean hintHideIcon) - -
Set a hint that this notification's icon should not be displayed.
- -
- - - - - - WearableNotifications.Builder - - setLocalOnly(boolean localOnly) - -
Set whether or not this notification is only relevant to the current device.
- -
- - - - - - WearableNotifications.Builder - - setMinPriority() - -
Set the priority of this notification to be minimum priority level - (PRIORITY_MIN).
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - WearableNotifications.Builder - (Context context) -

-
-
- - - -
-
- -

Construct a builder to be used for adding wearable extensions to notifications. Both the - wrapped builder (accessible via getCompatBuilder()) and this builder can be used - simultaneously, but the build() method from this object must be called in the end. - -

Always post notifications to the notification - system with the NotificationManagerCompat.notify(...) methods - instead of the NotificationManager.notify(...) methods. - - 

- WearableNotifications.Builder builder = new WearableNotifications.Builder(mContext)
-         .setLocalOnly(true);
- builder.getCompatBuilder()
-         .setContentTitle("New mail from " + sender.toString())
-         .setContentText(subject)
-         .setSmallIcon(R.drawable.new_mail);
- Notification notif = builder.build();
- NotificationManagerCompat.from(mContext).notify(0, notif);
-

- -
-
- - - - -
-

- - public - - - - - - - WearableNotifications.Builder - (NotificationCompat.Builder builder) -

-
-
- - - -
-
- -

Construct a builder to be used for adding wearable extensions to notifications to - a NotificationCompat.Builder. Both the wrapped builder and this - builder can be used simultaneously, but the build() method from this object must be - called in the end. -

Always post notifications to the notification - system with the NotificationManagerCompat.notify(...) methods - instead of the NotificationManager.notify(...) methods. - - 

- NotificationCompat.Builder builder = new NotificationCompat.Builder(mContext)
-         .setContentTitle("New mail from " + sender.toString())
-         .setContentText(subject)
-         .setSmallIcon(R.drawable.new_mail);
- Notification notif = new WearableNotifications.Builder(builder)
-         .setLocalOnly(true)
-         .build();
- NotificationManagerCompat.from(mContext).notify(0, notif);
-

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - WearableNotifications.Builder - - addAction - (WearableNotifications.Action action) -

-
-
- - - -
-
- -

Add an action to this notification. Actions are typically displayed by - the system as a button adjacent to the notification content. This method - accepts WearableNotifications.Action extension wrappers. Actions added by this function - are appended when build() is called.

-
-
Parameters
- - - - -
action - the action to add to this notification
-
-
-
Returns
-
  • this object for method chaining
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - WearableNotifications.Builder - - addPage - (Notification page) -

-
-
- - - -
-
- -

Add an additional page of content to display with this notification. The current - notification forms the first page, and pages added using this function form - subsequent pages. This field can be used to separate a notification into multiple - sections.

-
-
Parameters
- - - - -
page - the notification to add as another page
-
-
-
Returns
-
  • this object for method chaining
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - WearableNotifications.Builder - - addPages - (Collection<Notification> pages) -

-
-
- - - -
-
- -

Add additional pages of content to display with this notification. The current - notification forms the first page, and pages added using this function form - subsequent pages. This field can be used to separate a notification into multiple - sections.

-
-
Parameters
- - - - -
pages - a collection of notifications
-
-
-
Returns
-
  • this object for method chaining
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - WearableNotifications.Builder - - addRemoteInputForContentIntent - (RemoteInput input) -

-
-
- - - -
-
- -

Adds a RemoteInput for the content intent. The collected - data will be overlayed onto the content intent.

-
-
Parameters
- - - - -
input - a RemoteInput object to obtain a user response
-
-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - -
-

- - public - - - - - Notification - - build - () -

-
-
- - - -
-
- -

Combine all of the options that have been set by both this builder and - the wrapped NotificationCompat.Builder object and return a new - Notification object.

-
-
Returns
-
  • the notification -
-
- -
-
- - - - -
-

- - public - - - - - NotificationCompat.Builder - - getCompatBuilder - () -

-
-
- - - -
-
- -

Return the NotificationCompat.Builder being wrapped by this object.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - Bundle - - getExtras - () -

-
-
- - - -
-
- -

Get the current metadata Bundle used by this Builder, creating a new one - as necessary. - -

The returned Bundle is shared with this Builder.

-
-
Returns
-
  • the extras bundle -
-
- -
-
- - - - -
-

- - public - - - - - WearableNotifications.Builder - - setBigActionIcon - (int icon, CharSequence subtext) -

-
-
- - - -
-
- -

Add a big action display to this notification. Big actions show a hint to users - about the action taken when the content intent is triggered.

-
-
Parameters
- - - - - - - -
icon - icon to display for the content action.
subtext - Optional subtext to display with the big action icon.
-
-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - -
-

- - public - - - - - WearableNotifications.Builder - - setBigActionIcon - (int icon) -

-
-
- - - -
-
- -

Add a big action display to this notification. Big actions show a hint to users - about the action taken when the content intent is triggered.

-
-
Parameters
- - - - -
icon - icon to display for the content action.
-
-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - -
-

- - public - - - - - WearableNotifications.Builder - - setGroup - (String groupKey, int groupOrder) -

-
-
- - - -
-
- -

Set this notification to be part of a group of notifications sharing the same key. - Grouped notifications may display in a cluster or stack on devices which - support such rendering.

-
-
Parameters
- - - - - - - -
groupKey - The group key of the group. Unique within a package.
groupOrder - The 0-indexed sort order within the group. Can also be set - to the sentinel value GROUP_ORDER_SUMMARY to mark this - notification as being the group summary.
-
-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - -
-

- - public - - - - - WearableNotifications.Builder - - setGroup - (String groupKey) -

-
-
- - - -
-
- -

Set this notification to be part of a group of notifications sharing the same key. - Grouped notifications may display in a cluster or stack on devices which - support such rendering. Use the default ordering within a group.

-
-
Parameters
- - - - -
groupKey - The group key of the group. Unique within a package.
-
-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - -
-

- - public - - - - - WearableNotifications.Builder - - setHintHideIcon - (boolean hintHideIcon) -

-
-
- - - -
-
- -

Set a hint that this notification's icon should not be displayed.

-
-
Parameters
- - - - -
hintHideIcon - true to hide the icon, false otherwise.
-
-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - -
-

- - public - - - - - WearableNotifications.Builder - - setLocalOnly - (boolean localOnly) -

-
-
- - - -
-
- -

Set whether or not this notification is only relevant to the current device. - -

Some notifications can be bridged to other devices for remote display. - This hint can be set to recommend this notification not be bridged.

-
-
Parameters
- - - - -
localOnly - true to keep the notification on this device, - false otherwise. Default value is false.
-
-
-
Returns
-
  • this object for method chaining
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - WearableNotifications.Builder - - setMinPriority - () -

-
-
- - - -
-
- -

Set the priority of this notification to be minimum priority level - (PRIORITY_MIN). When set via WearableNotifications, these - minimum priority notifications will bypass the notification manager on platforms - that do not support ambient level notifications.

-
-
Returns
-
  • this object for method chaining -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.html b/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.html deleted file mode 100644 index c9948b8..0000000 --- a/docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.html +++ /dev/null @@ -1,2295 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WearableNotifications | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WearableNotifications

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.preview.support.wearable.notifications.WearableNotifications
- - - - - - - -
- - -

Class Overview

-

Helper class that contains wearable extensions for notifications. - Always use the WearableNotifications.Builder to create instances of this class. -

See - Creating Notifications - for Android Wear for more information on how to use this class. -

- To create a notification with wearable extensions: -

    -
  1. Create a NotificationCompat.Builder, setting any desired - properties. -
  2. Create a WearableNotifications.Builder, passing in the - NotificationCompat.Builder as a starting point. -
  3. Set wearable-specific properties using the - add and set methods of WearableNotifications.Builder. -
  4. Call build() to create the notification. -
  5. Post the notification to the notification - system with the NotificationManagerCompat.notify(...) methods - and not the NotificationManager.notify(...) methods. -
- - 
- NotificationCompat.Builder builder = new NotificationCompat.Builder(mContext)
-         .setContentTitle("New mail from " + sender.toString())
-         .setContentText(subject)
-         .setSmallIcon(R.drawable.new_mail);
- Notification notif = new WearableNotifications.Builder(builder)
-         .setLocalOnly(true)
-         .setMinPriority()
-         .build();
- NotificationManagerCompat.from(mContext).notify(0, notif);
-

When you receive a notification object from the builder, the methods in - this class let you access the values of various notification fields in - a backward-compatible manner. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classWearableNotifications.ActionSubclass of NotificationCompat.Action that adds additional - wearable extensions for actions. 
- - - - - classWearableNotifications.BuilderBuilder class that wraps a NotificationCompat.Builder to add - wearable extensions for a notification. 
- - - - - - - - - - - - - - - - - - -
Constants
intGROUP_ORDER_DEFAULTDefault value for the group sort order.
intGROUP_ORDER_SUMMARYSentinel value provided to the groupOrder parameter of the - setGroup(android.app.Notification, java.lang.String, int) - method.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - WearableNotifications.Action - - getAction(Notification notif, int actionIndex) - -
Get a WearableNotifications.Action wrapper for the notification at actionIndex - in the actions array.
- -
- - - - static - - int - - getActionCount(Notification notif) - -
Get the number of actions present on this notification.
- -
- - - - static - - int - - getBigActionIcon(Notification notif) - -
Get the big action icon to be displayed with this notification.
- -
- - - - static - - CharSequence - - getBigActionSubtext(Notification notif) - -
Get the big action icon subtext to be shown with a big action icon.
- -
- - - - static - - RemoteInput[] - - getContentIntentRemoteInputs(Notification notif) - -
Gets the RemoteInput objects associated with the content intent.
- -
- - - - static - - Bundle - - getExtras(Notification notif) - -
Gets the extras field from a notification in a backward-compatible - manner.
- -
- - - - static - - String - - getGroupKey(Notification notif) - -
Get the key used to group this notification into a cluster or stack - with other notifications.
- -
- - - - static - - int - - getGroupOrder(Notification notif) - -
Get the sort order of this notification within a group of notifications - with the same group key set.
- -
- - - - static - - boolean - - getHintHideIcon(Notification notif) - -
Get a hint that this notification's icon should not be displayed.
- -
- - - - static - - boolean - - getLocalOnly(Notification notif) - -
Get whether or not this notification is only relevant to the current device.
- -
- - - - static - - Notification[] - - getPages(Notification notif) - -
Get the array of additional pages of content for displaying this notification.
- -
- - - - static - - void - - setBigActionIcon(Notification notif, int icon) - -
Add a big action display to this notification.
- -
- - - - static - - void - - setBigActionIcon(Notification notif, int icon, CharSequence subtext) - -
Add a big action display to this notification.
- -
- - - - static - - void - - setContentIntentRemoteInputs(Notification notif, RemoteInput[] inputs) - -
Sets RemoteInputs to be collected when the user triggers the - contentIntent.
- -
- - - - static - - void - - setGroup(Notification notif, String groupKey) - -
Set this notification to be part of a group of notifications sharing the same key.
- -
- - - - static - - void - - setGroup(Notification notif, String groupKey, int groupOrder) - -
Set this notification to be part of a group of notifications sharing the same key.
- -
- - - - static - - void - - setHintHideIcon(Notification notif, boolean hintHideIcon) - -
Set a hint that this notification's icon should not be displayed.
- -
- - - - static - - void - - setLocalOnly(Notification notif, boolean localOnly) - -
Set whether or not this notification is only relevant to the current device.
- -
- - - - static - - void - - setMinPriority(Notification notif) - -
Set the priority of this notification to be minimum priority level - (PRIORITY_MIN).
- -
- - - - static - - void - - setPages(Notification notif, Notification[] pages) - -
Set additional pages of content to display with this notification.
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - GROUP_ORDER_DEFAULT -

-
- - - - -
-
- -

Default value for the group sort order. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GROUP_ORDER_SUMMARY -

-
- - - - -
-
- -

Sentinel value provided to the groupOrder parameter of the - setGroup(android.app.Notification, java.lang.String, int) - method. This value indicates that this index of the - notification group is the summary of the group. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - WearableNotifications.Action - - getAction - (Notification notif, int actionIndex) -

-
-
- - - -
-
- -

Get a WearableNotifications.Action wrapper for the notification at actionIndex - in the actions array.

-
-
Parameters
- - - - - - - -
notif - the notification to inspect
actionIndex - the index of the desired action -
-
- -
-
- - - - -
-

- - public - static - - - - int - - getActionCount - (Notification notif) -

-
-
- - - -
-
- -

Get the number of actions present on this notification.

-
-
Parameters
- - - - -
notif - the notification to inspect
-
-
-
Returns
-
  • the number of actions for this notification -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - static - - - - int - - getBigActionIcon - (Notification notif) -

-
-
- - - -
-
- -

Get the big action icon to be displayed with this notification. Big actions show - a hint to users about the action taken when the content intent is triggered.

-
-
Parameters
- - - - -
notif - the notification to inspect
-
-
-
Returns
-
  • the icon or 0 if it wasn't set
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - static - - - - CharSequence - - getBigActionSubtext - (Notification notif) -

-
-
- - - -
-
- -

Get the big action icon subtext to be shown with a big action icon.

-
-
Parameters
- - - - -
notif - the notification to inspect
-
-
-
Returns
-
  • the subtext of the big action icon or null if it wasn't exist.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - static - - - - RemoteInput[] - - getContentIntentRemoteInputs - (Notification notif) -

-
-
- - - -
-
- -

Gets the RemoteInput objects associated with the content intent.

-
-
Parameters
- - - - -
notif - the notification to inspect
-
-
-
Returns
-
  • array of RemoteInput objects or null if it doesn't exist -
-
- -
-
- - - - -
-

- - public - static - - - - Bundle - - getExtras - (Notification notif) -

-
-
- - - -
-
- -

Gets the extras field from a notification in a backward-compatible - manner. Extras field was supported from JellyBean (API level 16) - forwards. This function will return null on older API levels.

-
-
Parameters
- - - - -
notif - the notification to inspect
-
-
-
Returns
-
  • the extras associated with this notification. -
-
- -
-
- - - - -
-

- - public - static - - - - String - - getGroupKey - (Notification notif) -

-
-
- - - -
-
- -

Get the key used to group this notification into a cluster or stack - with other notifications. This key is unique within a package.

-
-
Parameters
- - - - -
notif - the notification to inspect -
-
- -
-
- - - - -
-

- - public - static - - - - int - - getGroupOrder - (Notification notif) -

-
-
- - - -
-
- -

Get the sort order of this notification within a group of notifications - with the same group key set. Group orders are 0-indexed integers that are used - to sort notifications in ascending order. Can also be the sentinel value - GROUP_ORDER_SUMMARY if this is the summary notification for a group.

-
-
Parameters
- - - - -
notif - the notification to inspect
-
-
-
Returns
-
  • the sort order of this notification within this group -
-
- -
-
- - - - -
-

- - public - static - - - - boolean - - getHintHideIcon - (Notification notif) -

-
-
- - - -
-
- -

Get a hint that this notification's icon should not be displayed.

-
-
Parameters
- - - - -
notif - the notification to inspect
-
-
-
Returns
-
  • true if this icon should not be displayed, false otherwise. - The default value is false if this was never set. -
-
- -
-
- - - - -
-

- - public - static - - - - boolean - - getLocalOnly - (Notification notif) -

-
-
- - - -
-
- -

Get whether or not this notification is only relevant to the current device. - -

Some notifications can be bridged to other devices for remote display. - If this hint is set, it is recommended that this notification not be bridged.

-
-
Parameters
- - - - -
notif - the notification to inspect
-
-
-
Returns
-
  • true if this notification is local only, false otherwise. - Default value is false if not set. -
-
- -
-
- - - - -
-

- - public - static - - - - Notification[] - - getPages - (Notification notif) -

-
-
- - - -
-
- -

Get the array of additional pages of content for displaying this notification. The - current notification forms the first page, and elements within this array form - subsequent pages. This field can be used to separate a notification into multiple - sections.

-
-
Parameters
- - - - -
notif - the notification to inspect
-
-
-
Returns
-
  • the pages for this notification -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setBigActionIcon - (Notification notif, int icon) -

-
-
- - - -
-
- -

Add a big action display to this notification. Big actions show a hint to users - about the action taken when the content intent is triggered.

-
-
Parameters
- - - - - - - -
notif - the notification to modify
icon - icon to display for the content action. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setBigActionIcon - (Notification notif, int icon, CharSequence subtext) -

-
-
- - - -
-
- -

Add a big action display to this notification. Big actions show a hint to users - about the action taken when the content intent is triggered.

-
-
Parameters
- - - - - - - - - - -
notif - the notification to modify
icon - icon to display for the content action.
subtext - Optional subtext to display with the big action icon. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setContentIntentRemoteInputs - (Notification notif, RemoteInput[] inputs) -

-
-
- - - -
-
- -

Sets RemoteInputs to be collected when the user triggers the - contentIntent. These function just as if they were attached to - an WearableNotifications.Action.

-
-
Parameters
- - - - - - - -
notif - the notification to modify
inputs - array of RemoteInput objects desired from the user. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setGroup - (Notification notif, String groupKey) -

-
-
- - - -
-
- -

Set this notification to be part of a group of notifications sharing the same key. - Grouped notifications may display in a cluster or stack on devices which - support such rendering. Use the default ordering within a group.

-
-
Parameters
- - - - - - - -
notif - the notification to modify
groupKey - The group key of the group. Unique within a package. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setGroup - (Notification notif, String groupKey, int groupOrder) -

-
-
- - - -
-
- -

Set this notification to be part of a group of notifications sharing the same key. - Grouped notifications may display in a cluster or stack on devices which - support such rendering.

-
-
Parameters
- - - - - - - - - - -
notif - the notification to modify
groupKey - The group key of the group. Unique within a package.
groupOrder - The 0-indexed sort order within the group. Can also be set - to the sentinel value GROUP_ORDER_SUMMARY to mark this - notification as being the group summary. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setHintHideIcon - (Notification notif, boolean hintHideIcon) -

-
-
- - - -
-
- -

Set a hint that this notification's icon should not be displayed.

-
-
Parameters
- - - - - - - -
notif - the notification to modify
hintHideIcon - true to hide this icon, false otherwise. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setLocalOnly - (Notification notif, boolean localOnly) -

-
-
- - - -
-
- -

Set whether or not this notification is only relevant to the current device. - -

Some notifications can be bridged to other devices for remote display. - This hint can be set to recommend this notification not be bridged.

-
-
Parameters
- - - - - - - -
notif - the notification to modify
localOnly - set to true to keep the notification on this device only, - false otherwise. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setMinPriority - (Notification notif) -

-
-
- - - -
-
- -

Set the priority of this notification to be minimum priority level - (PRIORITY_MIN). When set via WearableNotifications, these - minimum priority notifications will bypass the notification manager on platforms - that do not support ambient level notifications.

-
-
Parameters
- - - - -
notif - the notification to modify -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setPages - (Notification notif, Notification[] pages) -

-
-
- - - -
-
- -

Set additional pages of content to display with this notification. The current - notification forms the first page, and pages set using this function form - subsequent pages. This field can be used to separate a notification into multiple - sections.

-
-
Parameters
- - - - - - - -
notif - the notification to modify
pages - the pages to add to the current notification. Replaces any - existing pages with this value. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - -- cgit v1.1