blob: cd9c095890e7f3189234155e4d5a80a1bbcf5891 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/* //device/java/android/android/app/INotificationManager.aidl
2**
3** Copyright 2007, The Android Open Source Project
4**
Geoffrey Pitsche75a66e2016-11-22 11:12:11 -05005** Licensed under the Apache License, Version 2.0 (the "License");
6** you may not use this file except in compliance with the License.
7** You may obtain a copy of the License at
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008**
Geoffrey Pitsche75a66e2016-11-22 11:12:11 -05009** http://www.apache.org/licenses/LICENSE-2.0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010**
Geoffrey Pitsche75a66e2016-11-22 11:12:11 -050011** Unless required by applicable law or agreed to in writing, software
12** distributed under the License is distributed on an "AS IS" BASIS,
13** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14** See the License for the specific language governing permissions and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015** limitations under the License.
16*/
17
18package android.app;
19
20import android.app.ITransientNotification;
21import android.app.Notification;
Julia Reynoldsb5e44b72016-08-16 15:00:25 -040022import android.app.NotificationChannel;
Geoffrey Pitschdf44b602017-02-03 13:31:50 -050023import android.app.NotificationChannelGroup;
John Spurlock1fc476d2015-04-14 16:05:20 -040024import android.app.NotificationManager;
Daniel Sandler5feceeb2013-03-22 18:29:23 -070025import android.content.ComponentName;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080026import android.content.Intent;
Christoph Studercee44ba2014-05-20 18:36:43 +020027import android.content.pm.ParceledListSlice;
John Spurlocke77bb362014-04-26 10:24:59 -040028import android.net.Uri;
John Spurlock2b122f42014-08-27 16:29:47 -040029import android.os.Bundle;
Julia Reynoldsf27d6b22017-04-13 15:48:16 -040030import android.os.UserHandle;
Julia Reynoldse46bb372016-03-17 11:05:58 -040031import android.service.notification.Adjustment;
John Spurlock7340fc82014-04-24 18:50:12 -040032import android.service.notification.Condition;
John Spurlocke77bb362014-04-26 10:24:59 -040033import android.service.notification.IConditionListener;
John Spurlock7340fc82014-04-24 18:50:12 -040034import android.service.notification.IConditionProvider;
Daniel Sandler5feceeb2013-03-22 18:29:23 -070035import android.service.notification.INotificationListener;
John Spurlocke77bb362014-04-26 10:24:59 -040036import android.service.notification.StatusBarNotification;
Julia Reynoldsa47a27f2015-08-24 08:31:47 -040037import android.app.AutomaticZenRule;
John Spurlock056c5192014-04-20 21:52:01 -040038import android.service.notification.ZenModeConfig;
Daniel Sandlerfde19b12013-01-17 00:21:05 -050039
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080040/** {@hide} */
41interface INotificationManager
42{
Dianne Hackborn41203752012-08-31 14:05:51 -070043 void cancelAllNotifications(String pkg, int userId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080044
Julia Reynolds5355e852017-02-07 14:54:13 -050045 void clearData(String pkg, int uid, boolean fromApp);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080046 void enqueueToast(String pkg, ITransientNotification callback, int duration);
47 void cancelToast(String pkg, ITransientNotification callback);
Christoph Studer8fd7f1e2014-04-11 17:35:05 -040048 void enqueueNotificationWithTag(String pkg, String opPkg, String tag, int id,
Dianne Hackborn41203752012-08-31 14:05:51 -070049 in Notification notification, inout int[] idReceived, int userId);
50 void cancelNotificationWithTag(String pkg, String tag, int id, int userId);
Daniel Sandler0da673f2012-04-11 12:33:16 -040051
Julia Reynolds924eed12017-01-19 09:52:07 -050052 void setShowBadge(String pkg, int uid, boolean showBadge);
53 boolean canShowBadge(String pkg, int uid);
Daniel Sandler4a900ac2013-01-30 14:04:10 -050054 void setNotificationsEnabledForPackage(String pkg, int uid, boolean enabled);
55 boolean areNotificationsEnabledForPackage(String pkg, int uid);
Julia Reynolds81afbcd2016-02-09 14:54:08 -050056 boolean areNotificationsEnabled(String pkg);
Julia Reynoldsef37f282016-02-12 09:11:27 -050057 int getPackageImportance(String pkg);
Chris Wren3ad4e3a2014-09-02 17:23:51 -040058
Julia Reynolds59e152e2017-01-25 17:42:53 -050059 void createNotificationChannelGroups(String pkg, in ParceledListSlice channelGroupList);
Geoffrey Pitsch03533712017-01-05 10:30:07 -050060 void createNotificationChannels(String pkg, in ParceledListSlice channelsList);
Geoffrey Pitsch3560f842017-03-22 16:42:43 -040061 void createNotificationChannelsForPackage(String pkg, int uid, in ParceledListSlice channelsList);
Julia Reynolds59e152e2017-01-25 17:42:53 -050062 ParceledListSlice getNotificationChannelGroupsForPackage(String pkg, int uid, boolean includeDeleted);
Geoffrey Pitschdf44b602017-02-03 13:31:50 -050063 NotificationChannelGroup getNotificationChannelGroupForPackage(String groupId, String pkg, int uid);
Julia Reynoldsb5e44b72016-08-16 15:00:25 -040064 void updateNotificationChannelForPackage(String pkg, int uid, in NotificationChannel channel);
65 NotificationChannel getNotificationChannel(String pkg, String channelId);
Julia Reynolds4036e8d2017-01-13 09:50:05 -050066 NotificationChannel getNotificationChannelForPackage(String pkg, int uid, String channelId, boolean includeDeleted);
Julia Reynoldsb5e44b72016-08-16 15:00:25 -040067 void deleteNotificationChannel(String pkg, String channelId);
68 ParceledListSlice getNotificationChannels(String pkg);
Julia Reynolds4036e8d2017-01-13 09:50:05 -050069 ParceledListSlice getNotificationChannelsForPackage(String pkg, int uid, boolean includeDeleted);
Geoffrey Pitschdf44b602017-02-03 13:31:50 -050070 int getNumNotificationChannelsForPackage(String pkg, int uid, boolean includeDeleted);
Julia Reynolds41103f42017-03-15 11:36:35 -040071 int getDeletedChannelCount(String pkg, int uid);
Julia Reynolds9bfba592017-03-15 14:03:55 -040072 void deleteNotificationChannelGroup(String pkg, String channelGroupId);
73 ParceledListSlice getNotificationChannelGroups(String pkg);
Julia Reynoldsb5e44b72016-08-16 15:00:25 -040074
Christoph Studercee44ba2014-05-20 18:36:43 +020075 // TODO: Remove this when callers have been migrated to the equivalent
76 // INotificationListener method.
Daniel Sandlerfde19b12013-01-17 00:21:05 -050077 StatusBarNotification[] getActiveNotifications(String callingPkg);
Daniel Sandler78d0d252013-02-12 08:14:52 -050078 StatusBarNotification[] getHistoricalNotifications(String callingPkg, int count);
Daniel Sandler09a247e2013-02-14 10:24:17 -050079
Chris Wren0efdb882016-03-01 17:17:47 -050080 void registerListener(in INotificationListener listener, in ComponentName component, int userid);
Daniel Sandler09a247e2013-02-14 10:24:17 -050081 void unregisterListener(in INotificationListener listener, int userid);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080082
Daniel Sandlere6f7f2e2013-04-25 15:44:16 -040083 void cancelNotificationFromListener(in INotificationListener token, String pkg, String tag, int id);
John Spurlocka4294292014-03-24 18:02:32 -040084 void cancelNotificationsFromListener(in INotificationListener token, in String[] keys);
Daniel Sandler25cf8ce2013-04-24 15:34:57 -040085
Julia Reynolds79672302017-01-12 08:30:16 -050086 void snoozeNotificationUntilContextFromListener(in INotificationListener token, String key, String snoozeCriterionId);
Julia Reynoldsb6c1f992016-11-22 09:26:46 -050087 void snoozeNotificationUntilFromListener(in INotificationListener token, String key, long until);
Julia Reynolds72f1cbb2016-09-19 14:57:31 -040088
Chris Wrenab41eec2016-01-04 18:01:27 -050089 void requestBindListener(in ComponentName component);
90 void requestUnbindListener(in INotificationListener token);
Julia Reynolds38e6ca42016-08-08 08:38:09 -040091 void requestBindProvider(in ComponentName component);
92 void requestUnbindProvider(in IConditionProvider token);
Chris Wrenab41eec2016-01-04 18:01:27 -050093
Amith Yamasanif47e51e2015-04-17 10:02:15 -070094 void setNotificationsShownFromListener(in INotificationListener token, in String[] keys);
95
Christoph Studerb82bc782014-08-20 14:29:43 +020096 ParceledListSlice getActiveNotificationsFromListener(in INotificationListener token, in String[] keys, int trim);
Julia Reynoldscf63ff12017-01-24 13:55:48 -050097 ParceledListSlice getSnoozedNotificationsFromListener(in INotificationListener token, int trim);
John Spurlockd8afe3c2014-08-01 14:04:07 -040098 void requestHintsFromListener(in INotificationListener token, int hints);
99 int getHintsFromListener(in INotificationListener token);
Christoph Studer85a384b2014-08-27 20:16:15 +0200100 void requestInterruptionFilterFromListener(in INotificationListener token, int interruptionFilter);
101 int getInterruptionFilterFromListener(in INotificationListener token);
Christoph Studerb82bc782014-08-20 14:29:43 +0200102 void setOnNotificationPostedTrimFromListener(in INotificationListener token, int trim);
John Spurlock80774932015-05-07 17:38:50 -0400103 void setInterruptionFilter(String pkg, int interruptionFilter);
John Spurlock056c5192014-04-20 21:52:01 -0400104
Julia Reynoldsf27d6b22017-04-13 15:48:16 -0400105 void updateNotificationChannelFromPrivilegedListener(in INotificationListener token, String pkg, in UserHandle user, in NotificationChannel channel);
106 ParceledListSlice getNotificationChannelsFromPrivilegedListener(in INotificationListener token, String pkg, in UserHandle user);
107 ParceledListSlice getNotificationChannelGroupsFromPrivilegedListener(in INotificationListener token, String pkg, in UserHandle user);
Julia Reynolds73ed76b2017-04-04 17:04:38 -0400108
Julia Reynolds4b82f6d2017-01-04 10:47:41 -0500109 void applyEnqueuedAdjustmentFromAssistant(in INotificationListener token, in Adjustment adjustment);
Julia Reynolds52e64d02016-12-09 15:36:12 -0500110 void applyAdjustmentFromAssistant(in INotificationListener token, in Adjustment adjustment);
111 void applyAdjustmentsFromAssistant(in INotificationListener token, in List<Adjustment> adjustments);
Julia Reynoldscf63ff12017-01-24 13:55:48 -0500112 void unsnoozeNotificationFromAssistant(in INotificationListener token, String key);
Chris Wren51017d02015-12-15 15:34:46 -0500113
John Spurlockb4782522014-08-22 14:54:46 -0400114 ComponentName getEffectsSuppressor();
John Spurlock2b122f42014-08-27 16:29:47 -0400115 boolean matchesCallFilter(in Bundle extras);
John Spurlock530052a2014-11-30 16:26:19 -0500116 boolean isSystemConditionProviderEnabled(String path);
John Spurlockb4782522014-08-22 14:54:46 -0400117
John Spurlockb2278d62015-04-07 12:47:12 -0400118 int getZenMode();
John Spurlock056c5192014-04-20 21:52:01 -0400119 ZenModeConfig getZenModeConfig();
John Spurlockb2278d62015-04-07 12:47:12 -0400120 oneway void setZenMode(int mode, in Uri conditionId, String reason);
John Spurlocke77bb362014-04-26 10:24:59 -0400121 oneway void notifyConditions(String pkg, in IConditionProvider provider, in Condition[] conditions);
John Spurlock80774932015-05-07 17:38:50 -0400122 boolean isNotificationPolicyAccessGranted(String pkg);
123 NotificationManager.Policy getNotificationPolicy(String pkg);
124 void setNotificationPolicy(String pkg, in NotificationManager.Policy policy);
125 String[] getPackagesRequestingNotificationPolicyAccess();
126 boolean isNotificationPolicyAccessGrantedForPackage(String pkg);
127 void setNotificationPolicyAccessGranted(String pkg, boolean granted);
Julia Reynolds4fe98d62015-10-06 16:23:41 -0400128 AutomaticZenRule getAutomaticZenRule(String id);
Julia Reynolds361e82d32016-02-26 18:19:49 -0500129 List<ZenModeConfig.ZenRule> getZenRules();
130 String addAutomaticZenRule(in AutomaticZenRule automaticZenRule);
131 boolean updateAutomaticZenRule(String id, in AutomaticZenRule automaticZenRule);
Julia Reynolds4fe98d62015-10-06 16:23:41 -0400132 boolean removeAutomaticZenRule(String id);
Julia Reynoldsc8e54e82015-11-30 16:43:05 -0500133 boolean removeAutomaticZenRules(String packageName);
Julia Reynolds43b70cd2016-01-14 15:05:34 -0500134 int getRuleInstanceCount(in ComponentName owner);
Christopher Tatef9767d62015-04-08 14:35:43 -0700135
136 byte[] getBackupPayload(int user);
137 void applyRestore(in byte[] payload, int user);
Dan Sandler994349c2015-04-15 11:02:54 -0400138
139 ParceledListSlice getAppActiveNotifications(String callingPkg, int userId);
Dan Sandlerea75fdd2014-08-12 12:29:19 -0400140}