/* * Copyright (C) 2007 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.app; import android.annotation.NonNull; import android.annotation.Nullable; import android.annotation.SdkConstant; import android.app.Notification.Builder; import android.content.ComponentName; import android.content.Context; import android.content.pm.ParceledListSlice; import android.graphics.drawable.Icon; import android.net.Uri; import android.os.Build; import android.os.Bundle; import android.os.Handler; import android.os.IBinder; import android.os.Parcel; import android.os.Parcelable; import android.os.RemoteException; import android.os.ServiceManager; import android.os.StrictMode; import android.os.UserHandle; import android.provider.Settings.Global; import android.service.notification.IConditionListener; import android.service.notification.StatusBarNotification; import android.service.notification.ZenModeConfig; import android.util.ArraySet; import android.util.Log; import java.util.Objects; import java.util.List; /** * Class to notify the user of events that happen. This is how you tell * the user that something has happened in the background. {@more} * * Notifications can take different forms: * * *

* Each of the notify methods takes an int id parameter and optionally a * {@link String} tag parameter, which may be {@code null}. These parameters * are used to form a pair (tag, id), or ({@code null}, id) if tag is * unspecified. This pair identifies this notification from your app to the * system, so that pair should be unique within your app. If you call one * of the notify methods with a (tag, id) pair that is currently active and * a new set of notification parameters, it will be updated. For example, * if you pass a new status bar icon, the old icon in the status bar will * be replaced with the new one. This is also the same tag and id you pass * to the {@link #cancel(int)} or {@link #cancel(String, int)} method to clear * this notification. * *

* You do not instantiate this class directly; instead, retrieve it through * {@link android.content.Context#getSystemService}. * *

*

Developer Guides

*

For a guide to creating notifications, read the * Status Bar Notifications * developer guide.

*
* * @see android.app.Notification * @see android.content.Context#getSystemService */ public class NotificationManager { private static String TAG = "NotificationManager"; private static boolean localLOGV = false; /** * Intent that is broadcast when the state of {@link #getEffectsSuppressor()} changes. * This broadcast is only sent to registered receivers. * * @hide */ @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION) public static final String ACTION_EFFECTS_SUPPRESSOR_CHANGED = "android.os.action.ACTION_EFFECTS_SUPPRESSOR_CHANGED"; /** * Intent that is broadcast when the state of {@link #isNotificationPolicyAccessGranted()} * changes. * * This broadcast is only sent to registered receivers, and only to the apps that have changed. */ @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION) public static final String ACTION_NOTIFICATION_POLICY_ACCESS_GRANTED_CHANGED = "android.app.action.NOTIFICATION_POLICY_ACCESS_GRANTED_CHANGED"; /** * Intent that is broadcast when the state of getNotificationPolicy() changes. * This broadcast is only sent to registered receivers. */ @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION) public static final String ACTION_NOTIFICATION_POLICY_CHANGED = "android.app.action.NOTIFICATION_POLICY_CHANGED"; /** * Intent that is broadcast when the state of getCurrentInterruptionFilter() changes. * This broadcast is only sent to registered receivers. */ @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION) public static final String ACTION_INTERRUPTION_FILTER_CHANGED = "android.app.action.INTERRUPTION_FILTER_CHANGED"; /** * {@link #getCurrentInterruptionFilter() Interruption filter} constant - * Normal interruption filter. */ public static final int INTERRUPTION_FILTER_ALL = 1; /** * {@link #getCurrentInterruptionFilter() Interruption filter} constant - * Priority interruption filter. */ public static final int INTERRUPTION_FILTER_PRIORITY = 2; /** * {@link #getCurrentInterruptionFilter() Interruption filter} constant - * No interruptions filter. */ public static final int INTERRUPTION_FILTER_NONE = 3; /** * {@link #getCurrentInterruptionFilter() Interruption filter} constant - * Alarms only interruption filter. */ public static final int INTERRUPTION_FILTER_ALARMS = 4; /** {@link #getCurrentInterruptionFilter() Interruption filter} constant - returned when * the value is unavailable for any reason. */ public static final int INTERRUPTION_FILTER_UNKNOWN = 0; private static INotificationManager sService; /** @hide */ static public INotificationManager getService() { if (sService != null) { return sService; } IBinder b = ServiceManager.getService("notification"); sService = INotificationManager.Stub.asInterface(b); return sService; } /*package*/ NotificationManager(Context context, Handler handler) { mContext = context; } /** {@hide} */ public static NotificationManager from(Context context) { return (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE); } /** * Post a notification to be shown in the status bar. If a notification with * the same id has already been posted by your application and has not yet been canceled, it * will be replaced by the updated information. * * @param id An identifier for this notification unique within your * application. * @param notification A {@link Notification} object describing what to show the user. Must not * be null. */ public void notify(int id, Notification notification) { notify(null, id, notification); } /** * Post a notification to be shown in the status bar. If a notification with * the same tag and id has already been posted by your application and has not yet been * canceled, it will be replaced by the updated information. * * @param tag A string identifier for this notification. May be {@code null}. * @param id An identifier for this notification. The pair (tag, id) must be unique * within your application. * @param notification A {@link Notification} object describing what to * show the user. Must not be null. */ public void notify(String tag, int id, Notification notification) { int[] idOut = new int[1]; INotificationManager service = getService(); String pkg = mContext.getPackageName(); if (notification.sound != null) { notification.sound = notification.sound.getCanonicalUri(); if (StrictMode.vmFileUriExposureEnabled()) { notification.sound.checkFileUriExposed("Notification.sound"); } } fixLegacySmallIcon(notification, pkg); if (mContext.getApplicationInfo().targetSdkVersion > Build.VERSION_CODES.LOLLIPOP_MR1) { if (notification.getSmallIcon() == null) { throw new IllegalArgumentException("Invalid notification (no valid small icon): " + notification); } } if (localLOGV) Log.v(TAG, pkg + ": notify(" + id + ", " + notification + ")"); Notification stripped = notification.clone(); Builder.stripForDelivery(stripped); try { service.enqueueNotificationWithTag(pkg, mContext.getOpPackageName(), tag, id, stripped, idOut, UserHandle.myUserId()); if (id != idOut[0]) { Log.w(TAG, "notify: id corrupted: sent " + id + ", got back " + idOut[0]); } } catch (RemoteException e) { } } /** * @hide */ public void notifyAsUser(String tag, int id, Notification notification, UserHandle user) { int[] idOut = new int[1]; INotificationManager service = getService(); String pkg = mContext.getPackageName(); if (notification.sound != null) { notification.sound = notification.sound.getCanonicalUri(); if (StrictMode.vmFileUriExposureEnabled()) { notification.sound.checkFileUriExposed("Notification.sound"); } } fixLegacySmallIcon(notification, pkg); if (localLOGV) Log.v(TAG, pkg + ": notify(" + id + ", " + notification + ")"); Notification stripped = notification.clone(); Builder.stripForDelivery(stripped); try { service.enqueueNotificationWithTag(pkg, mContext.getOpPackageName(), tag, id, stripped, idOut, user.getIdentifier()); if (id != idOut[0]) { Log.w(TAG, "notify: id corrupted: sent " + id + ", got back " + idOut[0]); } } catch (RemoteException e) { } } private void fixLegacySmallIcon(Notification n, String pkg) { if (n.getSmallIcon() == null && n.icon != 0) { n.setSmallIcon(Icon.createWithResource(pkg, n.icon)); } } /** * Cancel a previously shown notification. If it's transient, the view * will be hidden. If it's persistent, it will be removed from the status * bar. */ public void cancel(int id) { cancel(null, id); } /** * Cancel a previously shown notification. If it's transient, the view * will be hidden. If it's persistent, it will be removed from the status * bar. */ public void cancel(String tag, int id) { INotificationManager service = getService(); String pkg = mContext.getPackageName(); if (localLOGV) Log.v(TAG, pkg + ": cancel(" + id + ")"); try { service.cancelNotificationWithTag(pkg, tag, id, UserHandle.myUserId()); } catch (RemoteException e) { } } /** * @hide */ public void cancelAsUser(String tag, int id, UserHandle user) { INotificationManager service = getService(); String pkg = mContext.getPackageName(); if (localLOGV) Log.v(TAG, pkg + ": cancel(" + id + ")"); try { service.cancelNotificationWithTag(pkg, tag, id, user.getIdentifier()); } catch (RemoteException e) { } } /** * Cancel all previously shown notifications. See {@link #cancel} for the * detailed behavior. */ public void cancelAll() { INotificationManager service = getService(); String pkg = mContext.getPackageName(); if (localLOGV) Log.v(TAG, pkg + ": cancelAll()"); try { service.cancelAllNotifications(pkg, UserHandle.myUserId()); } catch (RemoteException e) { } } /** * @hide */ public ComponentName getEffectsSuppressor() { INotificationManager service = getService(); try { return service.getEffectsSuppressor(); } catch (RemoteException e) { return null; } } /** * @hide */ public boolean matchesCallFilter(Bundle extras) { INotificationManager service = getService(); try { return service.matchesCallFilter(extras); } catch (RemoteException e) { return false; } } /** * @hide */ public boolean isSystemConditionProviderEnabled(String path) { INotificationManager service = getService(); try { return service.isSystemConditionProviderEnabled(path); } catch (RemoteException e) { return false; } } /** * @hide */ public void setZenMode(int mode, Uri conditionId, String reason) { INotificationManager service = getService(); try { service.setZenMode(mode, conditionId, reason); } catch (RemoteException e) { } } /** * @hide */ public boolean setZenModeConfig(ZenModeConfig config, String reason) { INotificationManager service = getService(); try { return service.setZenModeConfig(config, reason); } catch (RemoteException e) { return false; } } /** * @hide */ public void requestZenModeConditions(IConditionListener listener, int relevance) { INotificationManager service = getService(); try { service.requestZenModeConditions(listener, relevance); } catch (RemoteException e) { } } /** * @hide */ public int getZenMode() { INotificationManager service = getService(); try { return service.getZenMode(); } catch (RemoteException e) { } return Global.ZEN_MODE_OFF; } /** * @hide */ public ZenModeConfig getZenModeConfig() { INotificationManager service = getService(); try { return service.getZenModeConfig(); } catch (RemoteException e) { } return null; } /** * Checks the ability to read/modify notification policy for the calling package. * *

* Returns true if the calling package can read/modify notification policy. * *

* Request policy access by sending the user to the activity that matches the system intent * action {@link android.provider.Settings#ACTION_NOTIFICATION_POLICY_ACCESS_SETTINGS}. * *

* Use {@link #ACTION_NOTIFICATION_POLICY_ACCESS_GRANTED_CHANGED} to listen for * user grant or denial of this access. */ public boolean isNotificationPolicyAccessGranted() { INotificationManager service = getService(); try { return service.isNotificationPolicyAccessGranted(mContext.getOpPackageName()); } catch (RemoteException e) { } return false; } /** @hide */ public boolean isNotificationPolicyAccessGrantedForPackage(String pkg) { INotificationManager service = getService(); try { return service.isNotificationPolicyAccessGrantedForPackage(pkg); } catch (RemoteException e) { } return false; } /** * Gets the current notification policy. * *

* Only available if policy access is granted to this package. * See {@link #isNotificationPolicyAccessGranted}. */ public Policy getNotificationPolicy() { INotificationManager service = getService(); try { return service.getNotificationPolicy(mContext.getOpPackageName()); } catch (RemoteException e) { } return null; } /** * Sets the current notification policy. * *

* Only available if policy access is granted to this package. * See {@link #isNotificationPolicyAccessGranted}. * * @param policy The new desired policy. */ public void setNotificationPolicy(@NonNull Policy policy) { checkRequired("policy", policy); INotificationManager service = getService(); try { service.setNotificationPolicy(mContext.getOpPackageName(), policy); } catch (RemoteException e) { } } /** @hide */ public void setNotificationPolicyAccessGranted(String pkg, boolean granted) { INotificationManager service = getService(); try { service.setNotificationPolicyAccessGranted(pkg, granted); } catch (RemoteException e) { } } /** @hide */ public ArraySet getPackagesRequestingNotificationPolicyAccess() { INotificationManager service = getService(); try { final String[] pkgs = service.getPackagesRequestingNotificationPolicyAccess(); if (pkgs != null && pkgs.length > 0) { final ArraySet rt = new ArraySet<>(pkgs.length); for (int i = 0; i < pkgs.length; i++) { rt.add(pkgs[i]); } return rt; } } catch (RemoteException e) { } return new ArraySet(); } private Context mContext; private static void checkRequired(String name, Object value) { if (value == null) { throw new IllegalArgumentException(name + " is required"); } } /** * Notification policy configuration. Represents user-preferences for notification * filtering and prioritization. */ public static class Policy implements android.os.Parcelable { /** Reminder notifications are prioritized. */ public static final int PRIORITY_CATEGORY_REMINDERS = 1 << 0; /** Event notifications are prioritized. */ public static final int PRIORITY_CATEGORY_EVENTS = 1 << 1; /** Message notifications are prioritized. */ public static final int PRIORITY_CATEGORY_MESSAGES = 1 << 2; /** Calls are prioritized. */ public static final int PRIORITY_CATEGORY_CALLS = 1 << 3; /** Calls from repeat callers are prioritized. */ public static final int PRIORITY_CATEGORY_REPEAT_CALLERS = 1 << 4; private static final int[] ALL_PRIORITY_CATEGORIES = { PRIORITY_CATEGORY_REMINDERS, PRIORITY_CATEGORY_EVENTS, PRIORITY_CATEGORY_MESSAGES, PRIORITY_CATEGORY_CALLS, PRIORITY_CATEGORY_REPEAT_CALLERS, }; /** Any sender is prioritized. */ public static final int PRIORITY_SENDERS_ANY = 0; /** Saved contacts are prioritized. */ public static final int PRIORITY_SENDERS_CONTACTS = 1; /** Only starred contacts are prioritized. */ public static final int PRIORITY_SENDERS_STARRED = 2; /** Notification categories to prioritize. Bitmask of PRIORITY_CATEGORY_* constants. */ public final int priorityCategories; /** Notification senders to prioritize for calls. One of: * PRIORITY_SENDERS_ANY, PRIORITY_SENDERS_CONTACTS, PRIORITY_SENDERS_STARRED */ public final int priorityCallSenders; /** Notification senders to prioritize for messages. One of: * PRIORITY_SENDERS_ANY, PRIORITY_SENDERS_CONTACTS, PRIORITY_SENDERS_STARRED */ public final int priorityMessageSenders; public Policy(int priorityCategories, int priorityCallSenders, int priorityMessageSenders) { this.priorityCategories = priorityCategories; this.priorityCallSenders = priorityCallSenders; this.priorityMessageSenders = priorityMessageSenders; } /** @hide */ public Policy(Parcel source) { this(source.readInt(), source.readInt(), source.readInt()); } @Override public void writeToParcel(Parcel dest, int flags) { dest.writeInt(priorityCategories); dest.writeInt(priorityCallSenders); dest.writeInt(priorityMessageSenders); } @Override public int describeContents() { return 0; } @Override public int hashCode() { return Objects.hash(priorityCategories, priorityCallSenders, priorityMessageSenders); } @Override public boolean equals(Object o) { if (!(o instanceof Policy)) return false; if (o == this) return true; final Policy other = (Policy) o; return other.priorityCategories == priorityCategories && other.priorityCallSenders == priorityCallSenders && other.priorityMessageSenders == priorityMessageSenders; } @Override public String toString() { return "NotificationManager.Policy[" + "priorityCategories=" + priorityCategoriesToString(priorityCategories) + ",priorityCallSenders=" + prioritySendersToString(priorityCallSenders) + ",priorityMessageSenders=" + prioritySendersToString(priorityMessageSenders) + "]"; } public static String priorityCategoriesToString(int priorityCategories) { if (priorityCategories == 0) return ""; final StringBuilder sb = new StringBuilder(); for (int i = 0; i < ALL_PRIORITY_CATEGORIES.length; i++) { final int priorityCategory = ALL_PRIORITY_CATEGORIES[i]; if ((priorityCategories & priorityCategory) != 0) { if (sb.length() > 0) sb.append(','); sb.append(priorityCategoryToString(priorityCategory)); } priorityCategories &= ~priorityCategory; } if (priorityCategories != 0) { if (sb.length() > 0) sb.append(','); sb.append("PRIORITY_CATEGORY_UNKNOWN_").append(priorityCategories); } return sb.toString(); } private static String priorityCategoryToString(int priorityCategory) { switch (priorityCategory) { case PRIORITY_CATEGORY_REMINDERS: return "PRIORITY_CATEGORY_REMINDERS"; case PRIORITY_CATEGORY_EVENTS: return "PRIORITY_CATEGORY_EVENTS"; case PRIORITY_CATEGORY_MESSAGES: return "PRIORITY_CATEGORY_MESSAGES"; case PRIORITY_CATEGORY_CALLS: return "PRIORITY_CATEGORY_CALLS"; case PRIORITY_CATEGORY_REPEAT_CALLERS: return "PRIORITY_CATEGORY_REPEAT_CALLERS"; default: return "PRIORITY_CATEGORY_UNKNOWN_" + priorityCategory; } } public static String prioritySendersToString(int prioritySenders) { switch (prioritySenders) { case PRIORITY_SENDERS_ANY: return "PRIORITY_SENDERS_ANY"; case PRIORITY_SENDERS_CONTACTS: return "PRIORITY_SENDERS_CONTACTS"; case PRIORITY_SENDERS_STARRED: return "PRIORITY_SENDERS_STARRED"; default: return "PRIORITY_SENDERS_UNKNOWN_" + prioritySenders; } } public static final Parcelable.Creator CREATOR = new Parcelable.Creator() { @Override public Policy createFromParcel(Parcel in) { return new Policy(in); } @Override public Policy[] newArray(int size) { return new Policy[size]; } }; } /** * Recover a list of active notifications: ones that have been posted by the calling app that * have not yet been dismissed by the user or {@link #cancel(String, int)}ed by the app. * * Each notification is embedded in a {@link StatusBarNotification} object, including the * original tag and id supplied to * {@link #notify(String, int, Notification) notify()} * (via {@link StatusBarNotification#getTag() getTag()} and * {@link StatusBarNotification#getId() getId()}) as well as a copy of the original * {@link Notification} object (via {@link StatusBarNotification#getNotification()}). * * @return An array of {@link StatusBarNotification}. */ public StatusBarNotification[] getActiveNotifications() { final INotificationManager service = getService(); final String pkg = mContext.getPackageName(); try { final ParceledListSlice parceledList = service.getAppActiveNotifications(pkg, UserHandle.myUserId()); final List list = parceledList.getList(); return list.toArray(new StatusBarNotification[list.size()]); } catch (RemoteException e) { Log.e(TAG, "Unable to talk to notification manager. Woe!", e); } return new StatusBarNotification[0]; } /** * Gets the current notification interruption filter. * *

* The interruption filter defines which notifications are allowed to interrupt the user * (e.g. via sound & vibration) and is applied globally. * @return One of the INTERRUPTION_FILTER_ constants, or INTERRUPTION_FILTER_UNKNOWN when * unavailable. * *

* Only available if policy access is granted to this package. * See {@link #isNotificationPolicyAccessGranted}. */ public final int getCurrentInterruptionFilter() { final INotificationManager service = getService(); try { return zenModeToInterruptionFilter(service.getZenMode()); } catch (RemoteException e) { Log.e(TAG, "Unable to talk to notification manager. Woe!", e); } return INTERRUPTION_FILTER_UNKNOWN; } /** * Sets the current notification interruption filter. * *

* The interruption filter defines which notifications are allowed to interrupt the user * (e.g. via sound & vibration) and is applied globally. * @return One of the INTERRUPTION_FILTER_ constants, or INTERRUPTION_FILTER_UNKNOWN when * unavailable. * *

* Only available if policy access is granted to this package. * See {@link #isNotificationPolicyAccessGranted}. */ public final void setInterruptionFilter(int interruptionFilter) { final INotificationManager service = getService(); try { service.setInterruptionFilter(mContext.getOpPackageName(), interruptionFilter); } catch (RemoteException e) { Log.e(TAG, "Unable to talk to notification manager. Woe!", e); } } /** @hide */ public static int zenModeToInterruptionFilter(int zen) { switch (zen) { case Global.ZEN_MODE_OFF: return INTERRUPTION_FILTER_ALL; case Global.ZEN_MODE_IMPORTANT_INTERRUPTIONS: return INTERRUPTION_FILTER_PRIORITY; case Global.ZEN_MODE_ALARMS: return INTERRUPTION_FILTER_ALARMS; case Global.ZEN_MODE_NO_INTERRUPTIONS: return INTERRUPTION_FILTER_NONE; default: return INTERRUPTION_FILTER_UNKNOWN; } } /** @hide */ public static int zenModeFromInterruptionFilter(int interruptionFilter, int defValue) { switch (interruptionFilter) { case INTERRUPTION_FILTER_ALL: return Global.ZEN_MODE_OFF; case INTERRUPTION_FILTER_PRIORITY: return Global.ZEN_MODE_IMPORTANT_INTERRUPTIONS; case INTERRUPTION_FILTER_ALARMS: return Global.ZEN_MODE_ALARMS; case INTERRUPTION_FILTER_NONE: return Global.ZEN_MODE_NO_INTERRUPTIONS; default: return defValue; } } }