summaryrefslogtreecommitdiff
path: root/core/java/android/app/NotificationManager.java
diff options
context:
space:
mode:
authorJulia Reynolds <juliacr@google.com>2017-04-27 13:54:36 -0400
committerJulia Reynolds <juliacr@google.com>2017-04-27 20:53:34 +0000
commit0ffc13b9f2fb29c7d23cdafb31c3efef13b14639 (patch)
tree481faa058f1b3f2f60ed9063d419e1e90291b722 /core/java/android/app/NotificationManager.java
parent7e7f7d526d74b93903caac243749c6fd7df3be8d (diff)
Documentation updates
Test: make Change-Id: I9c02b3bd40ff19615747d238b1156d5d21e492e6 Fixes: 37736867 Bug: 37743680
Diffstat (limited to 'core/java/android/app/NotificationManager.java')
-rw-r--r--core/java/android/app/NotificationManager.java15
1 files changed, 12 insertions, 3 deletions
diff --git a/core/java/android/app/NotificationManager.java b/core/java/android/app/NotificationManager.java
index 7c361b9f9853..6c55548c2ea4 100644
--- a/core/java/android/app/NotificationManager.java
+++ b/core/java/android/app/NotificationManager.java
@@ -422,7 +422,9 @@ public class NotificationManager
* Creates a notification channel that notifications can be posted to.
*
* This can also be used to restore a deleted channel and to update an existing channel's
- * name and description. The name and description should only be changed if the locale changes
+ * name and description.
+ *
+ * <p>The name and description should only be changed if the locale changes
* or in response to the user renaming this channel. For example, if a user has a channel
* named 'John Doe' that represents messages from a 'John Doe', and 'John Doe' changes his name
* to 'John Smith,' the channel can be renamed to match.
@@ -454,6 +456,8 @@ public class NotificationManager
/**
* Returns the notification channel settings for a given channel id.
+ *
+ * The channel must belong to your package, or it will not be returned.
*/
public NotificationChannel getNotificationChannel(String channelId) {
INotificationManager service = getService();
@@ -465,7 +469,7 @@ public class NotificationManager
}
/**
- * Returns all notification channels belonging to the calling app.
+ * Returns all notification channels belonging to the calling package.
*/
public List<NotificationChannel> getNotificationChannels() {
INotificationManager service = getService();
@@ -478,6 +482,10 @@ public class NotificationManager
/**
* Deletes the given notification channel.
+ *
+ * <p>If you {@link #createNotificationChannel(NotificationChannel) create} a new channel with
+ * this same id, the deleted channel will be un-deleted with all of the same settings it
+ * had before it was deleted.
*/
public void deleteNotificationChannel(String channelId) {
INotificationManager service = getService();
@@ -501,7 +509,8 @@ public class NotificationManager
}
/**
- * Deletes the given notification channel group.
+ * Deletes the given notification channel group, and all notification channels that
+ * belong to it.
*/
public void deleteNotificationChannelGroup(String groupId) {
INotificationManager service = getService();