AlarmManager.java revision a4eb31d55a6b85f14fdb476a61434ffcceb7c367
1/* 2 * Copyright (C) 2007 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.app; 18 19import android.annotation.IntDef; 20import android.annotation.RequiresPermission; 21import android.annotation.SdkConstant; 22import android.annotation.SystemApi; 23import android.annotation.SystemService; 24import android.content.Context; 25import android.content.Intent; 26import android.os.Build; 27import android.os.Handler; 28import android.os.Parcel; 29import android.os.Parcelable; 30import android.os.RemoteException; 31import android.os.UserHandle; 32import android.os.WorkSource; 33import android.text.TextUtils; 34import android.util.ArrayMap; 35import android.util.Log; 36import android.util.proto.ProtoOutputStream; 37 38import libcore.util.ZoneInfoDB; 39 40import java.io.IOException; 41import java.lang.annotation.Retention; 42import java.lang.annotation.RetentionPolicy; 43 44/** 45 * This class provides access to the system alarm services. These allow you 46 * to schedule your application to be run at some point in the future. When 47 * an alarm goes off, the {@link Intent} that had been registered for it 48 * is broadcast by the system, automatically starting the target application 49 * if it is not already running. Registered alarms are retained while the 50 * device is asleep (and can optionally wake the device up if they go off 51 * during that time), but will be cleared if it is turned off and rebooted. 52 * 53 * <p>The Alarm Manager holds a CPU wake lock as long as the alarm receiver's 54 * onReceive() method is executing. This guarantees that the phone will not sleep 55 * until you have finished handling the broadcast. Once onReceive() returns, the 56 * Alarm Manager releases this wake lock. This means that the phone will in some 57 * cases sleep as soon as your onReceive() method completes. If your alarm receiver 58 * called {@link android.content.Context#startService Context.startService()}, it 59 * is possible that the phone will sleep before the requested service is launched. 60 * To prevent this, your BroadcastReceiver and Service will need to implement a 61 * separate wake lock policy to ensure that the phone continues running until the 62 * service becomes available. 63 * 64 * <p><b>Note: The Alarm Manager is intended for cases where you want to have 65 * your application code run at a specific time, even if your application is 66 * not currently running. For normal timing operations (ticks, timeouts, 67 * etc) it is easier and much more efficient to use 68 * {@link android.os.Handler}.</b> 69 * 70 * <p class="caution"><strong>Note:</strong> Beginning with API 19 71 * ({@link android.os.Build.VERSION_CODES#KITKAT}) alarm delivery is inexact: 72 * the OS will shift alarms in order to minimize wakeups and battery use. There are 73 * new APIs to support applications which need strict delivery guarantees; see 74 * {@link #setWindow(int, long, long, PendingIntent)} and 75 * {@link #setExact(int, long, PendingIntent)}. Applications whose {@code targetSdkVersion} 76 * is earlier than API 19 will continue to see the previous behavior in which all 77 * alarms are delivered exactly when requested. 78 */ 79@SystemService(Context.ALARM_SERVICE) 80public class AlarmManager { 81 private static final String TAG = "AlarmManager"; 82 83 /** @hide */ 84 @IntDef(prefix = { "RTC", "ELAPSED" }, value = { 85 RTC_WAKEUP, 86 RTC, 87 ELAPSED_REALTIME_WAKEUP, 88 ELAPSED_REALTIME, 89 }) 90 @Retention(RetentionPolicy.SOURCE) 91 public @interface AlarmType {} 92 93 /** 94 * Alarm time in {@link System#currentTimeMillis System.currentTimeMillis()} 95 * (wall clock time in UTC), which will wake up the device when 96 * it goes off. 97 */ 98 public static final int RTC_WAKEUP = 0; 99 /** 100 * Alarm time in {@link System#currentTimeMillis System.currentTimeMillis()} 101 * (wall clock time in UTC). This alarm does not wake the 102 * device up; if it goes off while the device is asleep, it will not be 103 * delivered until the next time the device wakes up. 104 */ 105 public static final int RTC = 1; 106 /** 107 * Alarm time in {@link android.os.SystemClock#elapsedRealtime 108 * SystemClock.elapsedRealtime()} (time since boot, including sleep), 109 * which will wake up the device when it goes off. 110 */ 111 public static final int ELAPSED_REALTIME_WAKEUP = 2; 112 /** 113 * Alarm time in {@link android.os.SystemClock#elapsedRealtime 114 * SystemClock.elapsedRealtime()} (time since boot, including sleep). 115 * This alarm does not wake the device up; if it goes off while the device 116 * is asleep, it will not be delivered until the next time the device 117 * wakes up. 118 */ 119 public static final int ELAPSED_REALTIME = 3; 120 121 /** 122 * Broadcast Action: Sent after the value returned by 123 * {@link #getNextAlarmClock()} has changed. 124 * 125 * <p class="note">This is a protected intent that can only be sent by the system. 126 * It is only sent to registered receivers.</p> 127 */ 128 @SdkConstant(SdkConstant.SdkConstantType.BROADCAST_INTENT_ACTION) 129 public static final String ACTION_NEXT_ALARM_CLOCK_CHANGED = 130 "android.app.action.NEXT_ALARM_CLOCK_CHANGED"; 131 132 /** @hide */ 133 public static final long WINDOW_EXACT = 0; 134 /** @hide */ 135 public static final long WINDOW_HEURISTIC = -1; 136 137 /** 138 * Flag for alarms: this is to be a stand-alone alarm, that should not be batched with 139 * other alarms. 140 * @hide 141 */ 142 public static final int FLAG_STANDALONE = 1<<0; 143 144 /** 145 * Flag for alarms: this alarm would like to wake the device even if it is idle. This 146 * is, for example, an alarm for an alarm clock. 147 * @hide 148 */ 149 public static final int FLAG_WAKE_FROM_IDLE = 1<<1; 150 151 /** 152 * Flag for alarms: this alarm would like to still execute even if the device is 153 * idle. This won't bring the device out of idle, just allow this specific alarm to 154 * run. Note that this means the actual time this alarm goes off can be inconsistent 155 * with the time of non-allow-while-idle alarms (it could go earlier than the time 156 * requested by another alarm). 157 * 158 * @hide 159 */ 160 public static final int FLAG_ALLOW_WHILE_IDLE = 1<<2; 161 162 /** 163 * Flag for alarms: same as {@link #FLAG_ALLOW_WHILE_IDLE}, but doesn't have restrictions 164 * on how frequently it can be scheduled. Only available (and automatically applied) to 165 * system alarms. 166 * 167 * @hide 168 */ 169 public static final int FLAG_ALLOW_WHILE_IDLE_UNRESTRICTED = 1<<3; 170 171 /** 172 * Flag for alarms: this alarm marks the point where we would like to come out of idle 173 * mode. It may be moved by the alarm manager to match the first wake-from-idle alarm. 174 * Scheduling an alarm with this flag puts the alarm manager in to idle mode, where it 175 * avoids scheduling any further alarms until the marker alarm is executed. 176 * @hide 177 */ 178 public static final int FLAG_IDLE_UNTIL = 1<<4; 179 180 private final IAlarmManager mService; 181 private final String mPackageName; 182 private final boolean mAlwaysExact; 183 private final int mTargetSdkVersion; 184 private final Handler mMainThreadHandler; 185 186 /** 187 * Direct-notification alarms: the requester must be running continuously from the 188 * time the alarm is set to the time it is delivered, or delivery will fail. Only 189 * one-shot alarms can be set using this mechanism, not repeating alarms. 190 */ 191 public interface OnAlarmListener { 192 /** 193 * Callback method that is invoked by the system when the alarm time is reached. 194 */ 195 public void onAlarm(); 196 } 197 198 final class ListenerWrapper extends IAlarmListener.Stub implements Runnable { 199 final OnAlarmListener mListener; 200 Handler mHandler; 201 IAlarmCompleteListener mCompletion; 202 203 public ListenerWrapper(OnAlarmListener listener) { 204 mListener = listener; 205 } 206 207 public void setHandler(Handler h) { 208 mHandler = h; 209 } 210 211 public void cancel() { 212 try { 213 mService.remove(null, this); 214 } catch (RemoteException ex) { 215 throw ex.rethrowFromSystemServer(); 216 } 217 218 synchronized (AlarmManager.class) { 219 if (sWrappers != null) { 220 sWrappers.remove(mListener); 221 } 222 } 223 } 224 225 @Override 226 public void doAlarm(IAlarmCompleteListener alarmManager) { 227 mCompletion = alarmManager; 228 229 // Remove this listener from the wrapper cache first; the server side 230 // already considers it gone 231 synchronized (AlarmManager.class) { 232 if (sWrappers != null) { 233 sWrappers.remove(mListener); 234 } 235 } 236 237 mHandler.post(this); 238 } 239 240 @Override 241 public void run() { 242 // Now deliver it to the app 243 try { 244 mListener.onAlarm(); 245 } finally { 246 // No catch -- make sure to report completion to the system process, 247 // but continue to allow the exception to crash the app. 248 249 try { 250 mCompletion.alarmComplete(this); 251 } catch (Exception e) { 252 Log.e(TAG, "Unable to report completion to Alarm Manager!", e); 253 } 254 } 255 } 256 } 257 258 // Tracking of the OnAlarmListener -> wrapper mapping, for cancel() support. 259 // Access is synchronized on the AlarmManager class object. 260 private static ArrayMap<OnAlarmListener, ListenerWrapper> sWrappers; 261 262 /** 263 * package private on purpose 264 */ 265 AlarmManager(IAlarmManager service, Context ctx) { 266 mService = service; 267 268 mPackageName = ctx.getPackageName(); 269 mTargetSdkVersion = ctx.getApplicationInfo().targetSdkVersion; 270 mAlwaysExact = (mTargetSdkVersion < Build.VERSION_CODES.KITKAT); 271 mMainThreadHandler = new Handler(ctx.getMainLooper()); 272 } 273 274 private long legacyExactLength() { 275 return (mAlwaysExact ? WINDOW_EXACT : WINDOW_HEURISTIC); 276 } 277 278 /** 279 * <p>Schedule an alarm. <b>Note: for timing operations (ticks, timeouts, 280 * etc) it is easier and much more efficient to use {@link android.os.Handler}.</b> 281 * If there is already an alarm scheduled for the same IntentSender, that previous 282 * alarm will first be canceled. 283 * 284 * <p>If the stated trigger time is in the past, the alarm will be triggered 285 * immediately. If there is already an alarm for this Intent 286 * scheduled (with the equality of two intents being defined by 287 * {@link Intent#filterEquals}), then it will be removed and replaced by 288 * this one. 289 * 290 * <p> 291 * The alarm is an Intent broadcast that goes to a broadcast receiver that 292 * you registered with {@link android.content.Context#registerReceiver} 293 * or through the <receiver> tag in an AndroidManifest.xml file. 294 * 295 * <p> 296 * Alarm intents are delivered with a data extra of type int called 297 * {@link Intent#EXTRA_ALARM_COUNT Intent.EXTRA_ALARM_COUNT} that indicates 298 * how many past alarm events have been accumulated into this intent 299 * broadcast. Recurring alarms that have gone undelivered because the 300 * phone was asleep may have a count greater than one when delivered. 301 * 302 * <div class="note"> 303 * <p> 304 * <b>Note:</b> Beginning in API 19, the trigger time passed to this method 305 * is treated as inexact: the alarm will not be delivered before this time, but 306 * may be deferred and delivered some time later. The OS will use 307 * this policy in order to "batch" alarms together across the entire system, 308 * minimizing the number of times the device needs to "wake up" and minimizing 309 * battery use. In general, alarms scheduled in the near future will not 310 * be deferred as long as alarms scheduled far in the future. 311 * 312 * <p> 313 * With the new batching policy, delivery ordering guarantees are not as 314 * strong as they were previously. If the application sets multiple alarms, 315 * it is possible that these alarms' <em>actual</em> delivery ordering may not match 316 * the order of their <em>requested</em> delivery times. If your application has 317 * strong ordering requirements there are other APIs that you can use to get 318 * the necessary behavior; see {@link #setWindow(int, long, long, PendingIntent)} 319 * and {@link #setExact(int, long, PendingIntent)}. 320 * 321 * <p> 322 * Applications whose {@code targetSdkVersion} is before API 19 will 323 * continue to get the previous alarm behavior: all of their scheduled alarms 324 * will be treated as exact. 325 * </div> 326 * 327 * @param type type of alarm. 328 * @param triggerAtMillis time in milliseconds that the alarm should go 329 * off, using the appropriate clock (depending on the alarm type). 330 * @param operation Action to perform when the alarm goes off; 331 * typically comes from {@link PendingIntent#getBroadcast 332 * IntentSender.getBroadcast()}. 333 * 334 * @see android.os.Handler 335 * @see #setExact 336 * @see #setRepeating 337 * @see #setWindow 338 * @see #cancel 339 * @see android.content.Context#sendBroadcast 340 * @see android.content.Context#registerReceiver 341 * @see android.content.Intent#filterEquals 342 * @see #ELAPSED_REALTIME 343 * @see #ELAPSED_REALTIME_WAKEUP 344 * @see #RTC 345 * @see #RTC_WAKEUP 346 */ 347 public void set(@AlarmType int type, long triggerAtMillis, PendingIntent operation) { 348 setImpl(type, triggerAtMillis, legacyExactLength(), 0, 0, operation, null, null, 349 null, null, null); 350 } 351 352 /** 353 * Direct callback version of {@link #set(int, long, PendingIntent)}. Rather than 354 * supplying a PendingIntent to be sent when the alarm time is reached, this variant 355 * supplies an {@link OnAlarmListener} instance that will be invoked at that time. 356 * <p> 357 * The OnAlarmListener's {@link OnAlarmListener#onAlarm() onAlarm()} method will be 358 * invoked via the specified target Handler, or on the application's main looper 359 * if {@code null} is passed as the {@code targetHandler} parameter. 360 * 361 * @param type type of alarm. 362 * @param triggerAtMillis time in milliseconds that the alarm should go 363 * off, using the appropriate clock (depending on the alarm type). 364 * @param tag string describing the alarm, used for logging and battery-use 365 * attribution 366 * @param listener {@link OnAlarmListener} instance whose 367 * {@link OnAlarmListener#onAlarm() onAlarm()} method will be 368 * called when the alarm time is reached. A given OnAlarmListener instance can 369 * only be the target of a single pending alarm, just as a given PendingIntent 370 * can only be used with one alarm at a time. 371 * @param targetHandler {@link Handler} on which to execute the listener's onAlarm() 372 * callback, or {@code null} to run that callback on the main looper. 373 */ 374 public void set(@AlarmType int type, long triggerAtMillis, String tag, OnAlarmListener listener, 375 Handler targetHandler) { 376 setImpl(type, triggerAtMillis, legacyExactLength(), 0, 0, null, listener, tag, 377 targetHandler, null, null); 378 } 379 380 /** 381 * Schedule a repeating alarm. <b>Note: for timing operations (ticks, 382 * timeouts, etc) it is easier and much more efficient to use 383 * {@link android.os.Handler}.</b> If there is already an alarm scheduled 384 * for the same IntentSender, it will first be canceled. 385 * 386 * <p>Like {@link #set}, except you can also supply a period at which 387 * the alarm will automatically repeat. This alarm continues 388 * repeating until explicitly removed with {@link #cancel}. If the stated 389 * trigger time is in the past, the alarm will be triggered immediately, with an 390 * alarm count depending on how far in the past the trigger time is relative 391 * to the repeat interval. 392 * 393 * <p>If an alarm is delayed (by system sleep, for example, for non 394 * _WAKEUP alarm types), a skipped repeat will be delivered as soon as 395 * possible. After that, future alarms will be delivered according to the 396 * original schedule; they do not drift over time. For example, if you have 397 * set a recurring alarm for the top of every hour but the phone was asleep 398 * from 7:45 until 8:45, an alarm will be sent as soon as the phone awakens, 399 * then the next alarm will be sent at 9:00. 400 * 401 * <p>If your application wants to allow the delivery times to drift in 402 * order to guarantee that at least a certain time interval always elapses 403 * between alarms, then the approach to take is to use one-time alarms, 404 * scheduling the next one yourself when handling each alarm delivery. 405 * 406 * <p class="note"> 407 * <b>Note:</b> as of API 19, all repeating alarms are inexact. If your 408 * application needs precise delivery times then it must use one-time 409 * exact alarms, rescheduling each time as described above. Legacy applications 410 * whose {@code targetSdkVersion} is earlier than API 19 will continue to have all 411 * of their alarms, including repeating alarms, treated as exact. 412 * 413 * @param type type of alarm. 414 * @param triggerAtMillis time in milliseconds that the alarm should first 415 * go off, using the appropriate clock (depending on the alarm type). 416 * @param intervalMillis interval in milliseconds between subsequent repeats 417 * of the alarm. 418 * @param operation Action to perform when the alarm goes off; 419 * typically comes from {@link PendingIntent#getBroadcast 420 * IntentSender.getBroadcast()}. 421 * 422 * @see android.os.Handler 423 * @see #set 424 * @see #setExact 425 * @see #setWindow 426 * @see #cancel 427 * @see android.content.Context#sendBroadcast 428 * @see android.content.Context#registerReceiver 429 * @see android.content.Intent#filterEquals 430 * @see #ELAPSED_REALTIME 431 * @see #ELAPSED_REALTIME_WAKEUP 432 * @see #RTC 433 * @see #RTC_WAKEUP 434 */ 435 public void setRepeating(@AlarmType int type, long triggerAtMillis, 436 long intervalMillis, PendingIntent operation) { 437 setImpl(type, triggerAtMillis, legacyExactLength(), intervalMillis, 0, operation, 438 null, null, null, null, null); 439 } 440 441 /** 442 * Schedule an alarm to be delivered within a given window of time. This method 443 * is similar to {@link #set(int, long, PendingIntent)}, but allows the 444 * application to precisely control the degree to which its delivery might be 445 * adjusted by the OS. This method allows an application to take advantage of the 446 * battery optimizations that arise from delivery batching even when it has 447 * modest timeliness requirements for its alarms. 448 * 449 * <p> 450 * This method can also be used to achieve strict ordering guarantees among 451 * multiple alarms by ensuring that the windows requested for each alarm do 452 * not intersect. 453 * 454 * <p> 455 * When precise delivery is not required, applications should use the standard 456 * {@link #set(int, long, PendingIntent)} method. This will give the OS the most 457 * flexibility to minimize wakeups and battery use. For alarms that must be delivered 458 * at precisely-specified times with no acceptable variation, applications can use 459 * {@link #setExact(int, long, PendingIntent)}. 460 * 461 * @param type type of alarm. 462 * @param windowStartMillis The earliest time, in milliseconds, that the alarm should 463 * be delivered, expressed in the appropriate clock's units (depending on the alarm 464 * type). 465 * @param windowLengthMillis The length of the requested delivery window, 466 * in milliseconds. The alarm will be delivered no later than this many 467 * milliseconds after {@code windowStartMillis}. Note that this parameter 468 * is a <i>duration,</i> not the timestamp of the end of the window. 469 * @param operation Action to perform when the alarm goes off; 470 * typically comes from {@link PendingIntent#getBroadcast 471 * IntentSender.getBroadcast()}. 472 * 473 * @see #set 474 * @see #setExact 475 * @see #setRepeating 476 * @see #cancel 477 * @see android.content.Context#sendBroadcast 478 * @see android.content.Context#registerReceiver 479 * @see android.content.Intent#filterEquals 480 * @see #ELAPSED_REALTIME 481 * @see #ELAPSED_REALTIME_WAKEUP 482 * @see #RTC 483 * @see #RTC_WAKEUP 484 */ 485 public void setWindow(@AlarmType int type, long windowStartMillis, long windowLengthMillis, 486 PendingIntent operation) { 487 setImpl(type, windowStartMillis, windowLengthMillis, 0, 0, operation, 488 null, null, null, null, null); 489 } 490 491 /** 492 * Direct callback version of {@link #setWindow(int, long, long, PendingIntent)}. Rather 493 * than supplying a PendingIntent to be sent when the alarm time is reached, this variant 494 * supplies an {@link OnAlarmListener} instance that will be invoked at that time. 495 * <p> 496 * The OnAlarmListener {@link OnAlarmListener#onAlarm() onAlarm()} method will be 497 * invoked via the specified target Handler, or on the application's main looper 498 * if {@code null} is passed as the {@code targetHandler} parameter. 499 */ 500 public void setWindow(@AlarmType int type, long windowStartMillis, long windowLengthMillis, 501 String tag, OnAlarmListener listener, Handler targetHandler) { 502 setImpl(type, windowStartMillis, windowLengthMillis, 0, 0, null, listener, tag, 503 targetHandler, null, null); 504 } 505 506 /** 507 * Schedule an alarm to be delivered precisely at the stated time. 508 * 509 * <p> 510 * This method is like {@link #set(int, long, PendingIntent)}, but does not permit 511 * the OS to adjust the delivery time. The alarm will be delivered as nearly as 512 * possible to the requested trigger time. 513 * 514 * <p> 515 * <b>Note:</b> only alarms for which there is a strong demand for exact-time 516 * delivery (such as an alarm clock ringing at the requested time) should be 517 * scheduled as exact. Applications are strongly discouraged from using exact 518 * alarms unnecessarily as they reduce the OS's ability to minimize battery use. 519 * 520 * @param type type of alarm. 521 * @param triggerAtMillis time in milliseconds that the alarm should go 522 * off, using the appropriate clock (depending on the alarm type). 523 * @param operation Action to perform when the alarm goes off; 524 * typically comes from {@link PendingIntent#getBroadcast 525 * IntentSender.getBroadcast()}. 526 * 527 * @see #set 528 * @see #setRepeating 529 * @see #setWindow 530 * @see #cancel 531 * @see android.content.Context#sendBroadcast 532 * @see android.content.Context#registerReceiver 533 * @see android.content.Intent#filterEquals 534 * @see #ELAPSED_REALTIME 535 * @see #ELAPSED_REALTIME_WAKEUP 536 * @see #RTC 537 * @see #RTC_WAKEUP 538 */ 539 public void setExact(@AlarmType int type, long triggerAtMillis, PendingIntent operation) { 540 setImpl(type, triggerAtMillis, WINDOW_EXACT, 0, 0, operation, null, null, null, 541 null, null); 542 } 543 544 /** 545 * Direct callback version of {@link #setExact(int, long, PendingIntent)}. Rather 546 * than supplying a PendingIntent to be sent when the alarm time is reached, this variant 547 * supplies an {@link OnAlarmListener} instance that will be invoked at that time. 548 * <p> 549 * The OnAlarmListener's {@link OnAlarmListener#onAlarm() onAlarm()} method will be 550 * invoked via the specified target Handler, or on the application's main looper 551 * if {@code null} is passed as the {@code targetHandler} parameter. 552 */ 553 public void setExact(@AlarmType int type, long triggerAtMillis, String tag, 554 OnAlarmListener listener, Handler targetHandler) { 555 setImpl(type, triggerAtMillis, WINDOW_EXACT, 0, 0, null, listener, tag, 556 targetHandler, null, null); 557 } 558 559 /** 560 * Schedule an idle-until alarm, which will keep the alarm manager idle until 561 * the given time. 562 * @hide 563 */ 564 public void setIdleUntil(@AlarmType int type, long triggerAtMillis, String tag, 565 OnAlarmListener listener, Handler targetHandler) { 566 setImpl(type, triggerAtMillis, WINDOW_EXACT, 0, FLAG_IDLE_UNTIL, null, 567 listener, tag, targetHandler, null, null); 568 } 569 570 /** 571 * Schedule an alarm that represents an alarm clock, which will be used to notify the user 572 * when it goes off. The expectation is that when this alarm triggers, the application will 573 * further wake up the device to tell the user about the alarm -- turning on the screen, 574 * playing a sound, vibrating, etc. As such, the system will typically also use the 575 * information supplied here to tell the user about this upcoming alarm if appropriate. 576 * 577 * <p>Due to the nature of this kind of alarm, similar to {@link #setExactAndAllowWhileIdle}, 578 * these alarms will be allowed to trigger even if the system is in a low-power idle 579 * (a.k.a. doze) mode. The system may also do some prep-work when it sees that such an 580 * alarm coming up, to reduce the amount of background work that could happen if this 581 * causes the device to fully wake up -- this is to avoid situations such as a large number 582 * of devices having an alarm set at the same time in the morning, all waking up at that 583 * time and suddenly swamping the network with pending background work. As such, these 584 * types of alarms can be extremely expensive on battery use and should only be used for 585 * their intended purpose.</p> 586 * 587 * <p> 588 * This method is like {@link #setExact(int, long, PendingIntent)}, but implies 589 * {@link #RTC_WAKEUP}. 590 * 591 * @param info 592 * @param operation Action to perform when the alarm goes off; 593 * typically comes from {@link PendingIntent#getBroadcast 594 * IntentSender.getBroadcast()}. 595 * 596 * @see #set 597 * @see #setRepeating 598 * @see #setWindow 599 * @see #setExact 600 * @see #cancel 601 * @see #getNextAlarmClock() 602 * @see android.content.Context#sendBroadcast 603 * @see android.content.Context#registerReceiver 604 * @see android.content.Intent#filterEquals 605 */ 606 public void setAlarmClock(AlarmClockInfo info, PendingIntent operation) { 607 setImpl(RTC_WAKEUP, info.getTriggerTime(), WINDOW_EXACT, 0, 0, operation, 608 null, null, null, null, info); 609 } 610 611 /** @hide */ 612 @SystemApi 613 @RequiresPermission(android.Manifest.permission.UPDATE_DEVICE_STATS) 614 public void set(@AlarmType int type, long triggerAtMillis, long windowMillis, 615 long intervalMillis, PendingIntent operation, WorkSource workSource) { 616 setImpl(type, triggerAtMillis, windowMillis, intervalMillis, 0, operation, null, null, 617 null, workSource, null); 618 } 619 620 /** 621 * Direct callback version of {@link #set(int, long, long, long, PendingIntent, WorkSource)}. 622 * Note that repeating alarms must use the PendingIntent variant, not an OnAlarmListener. 623 * <p> 624 * The OnAlarmListener's {@link OnAlarmListener#onAlarm() onAlarm()} method will be 625 * invoked via the specified target Handler, or on the application's main looper 626 * if {@code null} is passed as the {@code targetHandler} parameter. 627 * 628 * @hide 629 */ 630 public void set(@AlarmType int type, long triggerAtMillis, long windowMillis, 631 long intervalMillis, String tag, OnAlarmListener listener, Handler targetHandler, 632 WorkSource workSource) { 633 setImpl(type, triggerAtMillis, windowMillis, intervalMillis, 0, null, listener, tag, 634 targetHandler, workSource, null); 635 } 636 637 /** 638 * Direct callback version of {@link #set(int, long, long, long, PendingIntent, WorkSource)}. 639 * Note that repeating alarms must use the PendingIntent variant, not an OnAlarmListener. 640 * <p> 641 * The OnAlarmListener's {@link OnAlarmListener#onAlarm() onAlarm()} method will be 642 * invoked via the specified target Handler, or on the application's main looper 643 * if {@code null} is passed as the {@code targetHandler} parameter. 644 * 645 * @hide 646 */ 647 @SystemApi 648 @RequiresPermission(android.Manifest.permission.UPDATE_DEVICE_STATS) 649 public void set(@AlarmType int type, long triggerAtMillis, long windowMillis, 650 long intervalMillis, OnAlarmListener listener, Handler targetHandler, 651 WorkSource workSource) { 652 setImpl(type, triggerAtMillis, windowMillis, intervalMillis, 0, null, listener, null, 653 targetHandler, workSource, null); 654 } 655 656 private void setImpl(@AlarmType int type, long triggerAtMillis, long windowMillis, 657 long intervalMillis, int flags, PendingIntent operation, final OnAlarmListener listener, 658 String listenerTag, Handler targetHandler, WorkSource workSource, 659 AlarmClockInfo alarmClock) { 660 if (triggerAtMillis < 0) { 661 /* NOTYET 662 if (mAlwaysExact) { 663 // Fatal error for KLP+ apps to use negative trigger times 664 throw new IllegalArgumentException("Invalid alarm trigger time " 665 + triggerAtMillis); 666 } 667 */ 668 triggerAtMillis = 0; 669 } 670 671 ListenerWrapper recipientWrapper = null; 672 if (listener != null) { 673 synchronized (AlarmManager.class) { 674 if (sWrappers == null) { 675 sWrappers = new ArrayMap<OnAlarmListener, ListenerWrapper>(); 676 } 677 678 recipientWrapper = sWrappers.get(listener); 679 // no existing wrapper => build a new one 680 if (recipientWrapper == null) { 681 recipientWrapper = new ListenerWrapper(listener); 682 sWrappers.put(listener, recipientWrapper); 683 } 684 } 685 686 final Handler handler = (targetHandler != null) ? targetHandler : mMainThreadHandler; 687 recipientWrapper.setHandler(handler); 688 } 689 690 try { 691 mService.set(mPackageName, type, triggerAtMillis, windowMillis, intervalMillis, flags, 692 operation, recipientWrapper, listenerTag, workSource, alarmClock); 693 } catch (RemoteException ex) { 694 throw ex.rethrowFromSystemServer(); 695 } 696 } 697 698 /** 699 * Available inexact recurrence interval recognized by 700 * {@link #setInexactRepeating(int, long, long, PendingIntent)} 701 * when running on Android prior to API 19. 702 */ 703 public static final long INTERVAL_FIFTEEN_MINUTES = 15 * 60 * 1000; 704 705 /** 706 * Available inexact recurrence interval recognized by 707 * {@link #setInexactRepeating(int, long, long, PendingIntent)} 708 * when running on Android prior to API 19. 709 */ 710 public static final long INTERVAL_HALF_HOUR = 2*INTERVAL_FIFTEEN_MINUTES; 711 712 /** 713 * Available inexact recurrence interval recognized by 714 * {@link #setInexactRepeating(int, long, long, PendingIntent)} 715 * when running on Android prior to API 19. 716 */ 717 public static final long INTERVAL_HOUR = 2*INTERVAL_HALF_HOUR; 718 719 /** 720 * Available inexact recurrence interval recognized by 721 * {@link #setInexactRepeating(int, long, long, PendingIntent)} 722 * when running on Android prior to API 19. 723 */ 724 public static final long INTERVAL_HALF_DAY = 12*INTERVAL_HOUR; 725 726 /** 727 * Available inexact recurrence interval recognized by 728 * {@link #setInexactRepeating(int, long, long, PendingIntent)} 729 * when running on Android prior to API 19. 730 */ 731 public static final long INTERVAL_DAY = 2*INTERVAL_HALF_DAY; 732 733 /** 734 * Schedule a repeating alarm that has inexact trigger time requirements; 735 * for example, an alarm that repeats every hour, but not necessarily at 736 * the top of every hour. These alarms are more power-efficient than 737 * the strict recurrences traditionally supplied by {@link #setRepeating}, since the 738 * system can adjust alarms' delivery times to cause them to fire simultaneously, 739 * avoiding waking the device from sleep more than necessary. 740 * 741 * <p>Your alarm's first trigger will not be before the requested time, 742 * but it might not occur for almost a full interval after that time. In 743 * addition, while the overall period of the repeating alarm will be as 744 * requested, the time between any two successive firings of the alarm 745 * may vary. If your application demands very low jitter, use 746 * one-shot alarms with an appropriate window instead; see {@link 747 * #setWindow(int, long, long, PendingIntent)} and 748 * {@link #setExact(int, long, PendingIntent)}. 749 * 750 * <p class="note"> 751 * As of API 19, all repeating alarms are inexact. Because this method has 752 * been available since API 3, your application can safely call it and be 753 * assured that it will get similar behavior on both current and older versions 754 * of Android. 755 * 756 * @param type type of alarm. 757 * @param triggerAtMillis time in milliseconds that the alarm should first 758 * go off, using the appropriate clock (depending on the alarm type). This 759 * is inexact: the alarm will not fire before this time, but there may be a 760 * delay of almost an entire alarm interval before the first invocation of 761 * the alarm. 762 * @param intervalMillis interval in milliseconds between subsequent repeats 763 * of the alarm. Prior to API 19, if this is one of INTERVAL_FIFTEEN_MINUTES, 764 * INTERVAL_HALF_HOUR, INTERVAL_HOUR, INTERVAL_HALF_DAY, or INTERVAL_DAY 765 * then the alarm will be phase-aligned with other alarms to reduce the 766 * number of wakeups. Otherwise, the alarm will be set as though the 767 * application had called {@link #setRepeating}. As of API 19, all repeating 768 * alarms will be inexact and subject to batching with other alarms regardless 769 * of their stated repeat interval. 770 * @param operation Action to perform when the alarm goes off; 771 * typically comes from {@link PendingIntent#getBroadcast 772 * IntentSender.getBroadcast()}. 773 * 774 * @see android.os.Handler 775 * @see #set 776 * @see #cancel 777 * @see android.content.Context#sendBroadcast 778 * @see android.content.Context#registerReceiver 779 * @see android.content.Intent#filterEquals 780 * @see #ELAPSED_REALTIME 781 * @see #ELAPSED_REALTIME_WAKEUP 782 * @see #RTC 783 * @see #RTC_WAKEUP 784 * @see #INTERVAL_FIFTEEN_MINUTES 785 * @see #INTERVAL_HALF_HOUR 786 * @see #INTERVAL_HOUR 787 * @see #INTERVAL_HALF_DAY 788 * @see #INTERVAL_DAY 789 */ 790 public void setInexactRepeating(@AlarmType int type, long triggerAtMillis, 791 long intervalMillis, PendingIntent operation) { 792 setImpl(type, triggerAtMillis, WINDOW_HEURISTIC, intervalMillis, 0, operation, null, 793 null, null, null, null); 794 } 795 796 /** 797 * Like {@link #set(int, long, PendingIntent)}, but this alarm will be allowed to execute 798 * even when the system is in low-power idle (a.k.a. doze) modes. This type of alarm must 799 * <b>only</b> be used for situations where it is actually required that the alarm go off while 800 * in idle -- a reasonable example would be for a calendar notification that should make a 801 * sound so the user is aware of it. When the alarm is dispatched, the app will also be 802 * added to the system's temporary whitelist for approximately 10 seconds to allow that 803 * application to acquire further wake locks in which to complete its work.</p> 804 * 805 * <p>These alarms can significantly impact the power use 806 * of the device when idle (and thus cause significant battery blame to the app scheduling 807 * them), so they should be used with care. To reduce abuse, there are restrictions on how 808 * frequently these alarms will go off for a particular application. 809 * Under normal system operation, it will not dispatch these 810 * alarms more than about every minute (at which point every such pending alarm is 811 * dispatched); when in low-power idle modes this duration may be significantly longer, 812 * such as 15 minutes.</p> 813 * 814 * <p>Unlike other alarms, the system is free to reschedule this type of alarm to happen 815 * out of order with any other alarms, even those from the same app. This will clearly happen 816 * when the device is idle (since this alarm can go off while idle, when any other alarms 817 * from the app will be held until later), but may also happen even when not idle.</p> 818 * 819 * <p>Regardless of the app's target SDK version, this call always allows batching of the 820 * alarm.</p> 821 * 822 * @param type type of alarm. 823 * @param triggerAtMillis time in milliseconds that the alarm should go 824 * off, using the appropriate clock (depending on the alarm type). 825 * @param operation Action to perform when the alarm goes off; 826 * typically comes from {@link PendingIntent#getBroadcast 827 * IntentSender.getBroadcast()}. 828 * 829 * @see #set(int, long, PendingIntent) 830 * @see #setExactAndAllowWhileIdle 831 * @see #cancel 832 * @see android.content.Context#sendBroadcast 833 * @see android.content.Context#registerReceiver 834 * @see android.content.Intent#filterEquals 835 * @see #ELAPSED_REALTIME 836 * @see #ELAPSED_REALTIME_WAKEUP 837 * @see #RTC 838 * @see #RTC_WAKEUP 839 */ 840 public void setAndAllowWhileIdle(@AlarmType int type, long triggerAtMillis, 841 PendingIntent operation) { 842 setImpl(type, triggerAtMillis, WINDOW_HEURISTIC, 0, FLAG_ALLOW_WHILE_IDLE, 843 operation, null, null, null, null, null); 844 } 845 846 /** 847 * Like {@link #setExact(int, long, PendingIntent)}, but this alarm will be allowed to execute 848 * even when the system is in low-power idle modes. If you don't need exact scheduling of 849 * the alarm but still need to execute while idle, consider using 850 * {@link #setAndAllowWhileIdle}. This type of alarm must <b>only</b> 851 * be used for situations where it is actually required that the alarm go off while in 852 * idle -- a reasonable example would be for a calendar notification that should make a 853 * sound so the user is aware of it. When the alarm is dispatched, the app will also be 854 * added to the system's temporary whitelist for approximately 10 seconds to allow that 855 * application to acquire further wake locks in which to complete its work.</p> 856 * 857 * <p>These alarms can significantly impact the power use 858 * of the device when idle (and thus cause significant battery blame to the app scheduling 859 * them), so they should be used with care. To reduce abuse, there are restrictions on how 860 * frequently these alarms will go off for a particular application. 861 * Under normal system operation, it will not dispatch these 862 * alarms more than about every minute (at which point every such pending alarm is 863 * dispatched); when in low-power idle modes this duration may be significantly longer, 864 * such as 15 minutes.</p> 865 * 866 * <p>Unlike other alarms, the system is free to reschedule this type of alarm to happen 867 * out of order with any other alarms, even those from the same app. This will clearly happen 868 * when the device is idle (since this alarm can go off while idle, when any other alarms 869 * from the app will be held until later), but may also happen even when not idle. 870 * Note that the OS will allow itself more flexibility for scheduling these alarms than 871 * regular exact alarms, since the application has opted into this behavior. When the 872 * device is idle it may take even more liberties with scheduling in order to optimize 873 * for battery life.</p> 874 * 875 * @param type type of alarm. 876 * @param triggerAtMillis time in milliseconds that the alarm should go 877 * off, using the appropriate clock (depending on the alarm type). 878 * @param operation Action to perform when the alarm goes off; 879 * typically comes from {@link PendingIntent#getBroadcast 880 * IntentSender.getBroadcast()}. 881 * 882 * @see #set 883 * @see #setRepeating 884 * @see #setWindow 885 * @see #cancel 886 * @see android.content.Context#sendBroadcast 887 * @see android.content.Context#registerReceiver 888 * @see android.content.Intent#filterEquals 889 * @see #ELAPSED_REALTIME 890 * @see #ELAPSED_REALTIME_WAKEUP 891 * @see #RTC 892 * @see #RTC_WAKEUP 893 */ 894 public void setExactAndAllowWhileIdle(@AlarmType int type, long triggerAtMillis, 895 PendingIntent operation) { 896 setImpl(type, triggerAtMillis, WINDOW_EXACT, 0, FLAG_ALLOW_WHILE_IDLE, operation, 897 null, null, null, null, null); 898 } 899 900 /** 901 * Remove any alarms with a matching {@link Intent}. 902 * Any alarm, of any type, whose Intent matches this one (as defined by 903 * {@link Intent#filterEquals}), will be canceled. 904 * 905 * @param operation IntentSender which matches a previously added 906 * IntentSender. This parameter must not be {@code null}. 907 * 908 * @see #set 909 */ 910 public void cancel(PendingIntent operation) { 911 if (operation == null) { 912 final String msg = "cancel() called with a null PendingIntent"; 913 if (mTargetSdkVersion >= Build.VERSION_CODES.N) { 914 throw new NullPointerException(msg); 915 } else { 916 Log.e(TAG, msg); 917 return; 918 } 919 } 920 921 try { 922 mService.remove(operation, null); 923 } catch (RemoteException ex) { 924 throw ex.rethrowFromSystemServer(); 925 } 926 } 927 928 /** 929 * Remove any alarm scheduled to be delivered to the given {@link OnAlarmListener}. 930 * 931 * @param listener OnAlarmListener instance that is the target of a currently-set alarm. 932 */ 933 public void cancel(OnAlarmListener listener) { 934 if (listener == null) { 935 throw new NullPointerException("cancel() called with a null OnAlarmListener"); 936 } 937 938 ListenerWrapper wrapper = null; 939 synchronized (AlarmManager.class) { 940 if (sWrappers != null) { 941 wrapper = sWrappers.get(listener); 942 } 943 } 944 945 if (wrapper == null) { 946 Log.w(TAG, "Unrecognized alarm listener " + listener); 947 return; 948 } 949 950 wrapper.cancel(); 951 } 952 953 /** 954 * Set the system wall clock time. 955 * Requires the permission android.permission.SET_TIME. 956 * 957 * @param millis time in milliseconds since the Epoch 958 */ 959 public void setTime(long millis) { 960 try { 961 mService.setTime(millis); 962 } catch (RemoteException ex) { 963 throw ex.rethrowFromSystemServer(); 964 } 965 } 966 967 /** 968 * Sets the system's persistent default time zone. This is the time zone for all apps, even 969 * after a reboot. Use {@link java.util.TimeZone#setDefault} if you just want to change the 970 * time zone within your app, and even then prefer to pass an explicit 971 * {@link java.util.TimeZone} to APIs that require it rather than changing the time zone for 972 * all threads. 973 * 974 * <p> On android M and above, it is an error to pass in a non-Olson timezone to this 975 * function. Note that this is a bad idea on all Android releases because POSIX and 976 * the {@code TimeZone} class have opposite interpretations of {@code '+'} and {@code '-'} 977 * in the same non-Olson ID. 978 * 979 * @param timeZone one of the Olson ids from the list returned by 980 * {@link java.util.TimeZone#getAvailableIDs} 981 */ 982 public void setTimeZone(String timeZone) { 983 if (TextUtils.isEmpty(timeZone)) { 984 return; 985 } 986 987 // Reject this timezone if it isn't an Olson zone we recognize. 988 if (mTargetSdkVersion >= Build.VERSION_CODES.M) { 989 boolean hasTimeZone = false; 990 try { 991 hasTimeZone = ZoneInfoDB.getInstance().hasTimeZone(timeZone); 992 } catch (IOException ignored) { 993 } 994 995 if (!hasTimeZone) { 996 throw new IllegalArgumentException("Timezone: " + timeZone + " is not an Olson ID"); 997 } 998 } 999 1000 try { 1001 mService.setTimeZone(timeZone); 1002 } catch (RemoteException ex) { 1003 throw ex.rethrowFromSystemServer(); 1004 } 1005 } 1006 1007 /** @hide */ 1008 public long getNextWakeFromIdleTime() { 1009 try { 1010 return mService.getNextWakeFromIdleTime(); 1011 } catch (RemoteException ex) { 1012 throw ex.rethrowFromSystemServer(); 1013 } 1014 } 1015 1016 /** 1017 * Gets information about the next alarm clock currently scheduled. 1018 * 1019 * The alarm clocks considered are those scheduled by any application 1020 * using the {@link #setAlarmClock} method. 1021 * 1022 * @return An {@link AlarmClockInfo} object describing the next upcoming alarm 1023 * clock event that will occur. If there are no alarm clock events currently 1024 * scheduled, this method will return {@code null}. 1025 * 1026 * @see #setAlarmClock 1027 * @see AlarmClockInfo 1028 * @see #ACTION_NEXT_ALARM_CLOCK_CHANGED 1029 */ 1030 public AlarmClockInfo getNextAlarmClock() { 1031 return getNextAlarmClock(UserHandle.myUserId()); 1032 } 1033 1034 /** 1035 * Gets information about the next alarm clock currently scheduled. 1036 * 1037 * The alarm clocks considered are those scheduled by any application 1038 * using the {@link #setAlarmClock} method within the given user. 1039 * 1040 * @return An {@link AlarmClockInfo} object describing the next upcoming alarm 1041 * clock event that will occur within the given user. If there are no alarm clock 1042 * events currently scheduled in that user, this method will return {@code null}. 1043 * 1044 * @see #setAlarmClock 1045 * @see AlarmClockInfo 1046 * @see #ACTION_NEXT_ALARM_CLOCK_CHANGED 1047 * 1048 * @hide 1049 */ 1050 public AlarmClockInfo getNextAlarmClock(int userId) { 1051 try { 1052 return mService.getNextAlarmClock(userId); 1053 } catch (RemoteException ex) { 1054 throw ex.rethrowFromSystemServer(); 1055 } 1056 } 1057 1058 /** 1059 * An immutable description of a scheduled "alarm clock" event. 1060 * 1061 * @see AlarmManager#setAlarmClock 1062 * @see AlarmManager#getNextAlarmClock 1063 */ 1064 public static final class AlarmClockInfo implements Parcelable { 1065 1066 private final long mTriggerTime; 1067 private final PendingIntent mShowIntent; 1068 1069 /** 1070 * Creates a new alarm clock description. 1071 * 1072 * @param triggerTime time at which the underlying alarm is triggered in wall time 1073 * milliseconds since the epoch 1074 * @param showIntent an intent that can be used to show or edit details of 1075 * the alarm clock. 1076 */ 1077 public AlarmClockInfo(long triggerTime, PendingIntent showIntent) { 1078 mTriggerTime = triggerTime; 1079 mShowIntent = showIntent; 1080 } 1081 1082 /** 1083 * Use the {@link #CREATOR} 1084 * @hide 1085 */ 1086 AlarmClockInfo(Parcel in) { 1087 mTriggerTime = in.readLong(); 1088 mShowIntent = in.readParcelable(PendingIntent.class.getClassLoader()); 1089 } 1090 1091 /** 1092 * Returns the time at which the alarm is going to trigger. 1093 * 1094 * This value is UTC wall clock time in milliseconds, as returned by 1095 * {@link System#currentTimeMillis()} for example. 1096 */ 1097 public long getTriggerTime() { 1098 return mTriggerTime; 1099 } 1100 1101 /** 1102 * Returns an intent that can be used to show or edit details of the alarm clock in 1103 * the application that scheduled it. 1104 * 1105 * <p class="note">Beware that any application can retrieve and send this intent, 1106 * potentially with additional fields filled in. See 1107 * {@link PendingIntent#send(android.content.Context, int, android.content.Intent) 1108 * PendingIntent.send()} and {@link android.content.Intent#fillIn Intent.fillIn()} 1109 * for details. 1110 */ 1111 public PendingIntent getShowIntent() { 1112 return mShowIntent; 1113 } 1114 1115 @Override 1116 public int describeContents() { 1117 return 0; 1118 } 1119 1120 @Override 1121 public void writeToParcel(Parcel dest, int flags) { 1122 dest.writeLong(mTriggerTime); 1123 dest.writeParcelable(mShowIntent, flags); 1124 } 1125 1126 public static final Creator<AlarmClockInfo> CREATOR = new Creator<AlarmClockInfo>() { 1127 @Override 1128 public AlarmClockInfo createFromParcel(Parcel in) { 1129 return new AlarmClockInfo(in); 1130 } 1131 1132 @Override 1133 public AlarmClockInfo[] newArray(int size) { 1134 return new AlarmClockInfo[size]; 1135 } 1136 }; 1137 1138 /** @hide */ 1139 public void writeToProto(ProtoOutputStream proto, long fieldId) { 1140 final long token = proto.start(fieldId); 1141 proto.write(AlarmClockInfoProto.TRIGGER_TIME_MS, mTriggerTime); 1142 mShowIntent.writeToProto(proto, AlarmClockInfoProto.SHOW_INTENT); 1143 proto.end(token); 1144 } 1145 } 1146} 1147