Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

am 6b335380: am 47306086: am a681d7d9: Merge "Improve alarm manager docs." into mnc-dev

Browse Source 
* commit '6b33538053de038681ce41268f73edf9cd6ab9cb':
  Improve alarm manager docs.
This commit is contained in:
Dianne Hackborn
2015-07-10 02:12:46 +00:00
committed by Android Git Automerger
parent b3d012b983 6b33538053
commit 04efda6937
1 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
core/java/android/app/AlarmManager.java
View File

@@ -570,12 +570,15 @@ public class AlarmManager {
* even when the system is in low-power idle modes. This type of alarm must <b>only</b> * even when the system is in low-power idle modes. This type of alarm must <b>only</b>
* be used for situations where it is actually required that the alarm go off while in * be used for situations where it is actually required that the alarm go off while in
* idle -- a reasonable example would be for a calendar notification that should make a * idle -- a reasonable example would be for a calendar notification that should make a
* sound so the user is aware of it. These alarms can significantly impact the power use * sound so the user is aware of it. When the alarm is dispatched, the app will also be
* of the device when idle (and thus cause significant battery blame to the app scheduling * added to the system's temporary whitelist for approximately 10 seconds to allow that
* them), so they should be used with care. * application to acquire further wake locks in which to complete its work.</p>
* *
* <p>To reduce abuse, there are restrictions on how frequently these alarms will go off * <p>These alarms can significantly impact the power use
* for a particular application. Under normal system operation, it will not dispatch these * of the device when idle (and thus cause significant battery blame to the app scheduling
* them), so they should be used with care. To reduce abuse, there are restrictions on how
* frequently these alarms will go off for a particular application.
* Under normal system operation, it will not dispatch these
* alarms more than about every minute (at which point every such pending alarm is * alarms more than about every minute (at which point every such pending alarm is
* dispatched); when in low-power idle modes this duration may be significantly longer, * dispatched); when in low-power idle modes this duration may be significantly longer,
* such as 15 minutes.</p> * such as 15 minutes.</p>
@@ -619,12 +622,15 @@ public class AlarmManager {
* {@link #setAndAllowWhileIdle}. This type of alarm must <b>only</b> * {@link #setAndAllowWhileIdle}. This type of alarm must <b>only</b>
* be used for situations where it is actually required that the alarm go off while in * be used for situations where it is actually required that the alarm go off while in
* idle -- a reasonable example would be for a calendar notification that should make a * idle -- a reasonable example would be for a calendar notification that should make a
* sound so the user is aware of it. These alarms can significantly impact the power use * sound so the user is aware of it. When the alarm is dispatched, the app will also be
* of the device when idle (and thus cause significant battery blame to the app scheduling * added to the system's temporary whitelist for approximately 10 seconds to allow that
* them), so they should be used with care. * application to acquire further wake locks in which to complete its work.</p>
* *
* <p>To reduce abuse, there are restrictions on how frequently these alarms will go off * <p>These alarms can significantly impact the power use
* for a particular application. Under normal system operation, it will not dispatch these * of the device when idle (and thus cause significant battery blame to the app scheduling
* them), so they should be used with care. To reduce abuse, there are restrictions on how
* frequently these alarms will go off for a particular application.
* Under normal system operation, it will not dispatch these
* alarms more than about every minute (at which point every such pending alarm is * alarms more than about every minute (at which point every such pending alarm is
* dispatched); when in low-power idle modes this duration may be significantly longer, * dispatched); when in low-power idle modes this duration may be significantly longer,
* such as 15 minutes.</p> * such as 15 minutes.</p>