Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d710fb50 authored by Kenny Root's avatar Kenny Root
Browse files

Update WakeLock-related docs to mention permissions 

android.permission.WAKE_LOCK permission is required to use WakeLock or
WifiLock, but nowhere is it mentioned that you must declare that
permission to use it.

Change-Id: Ib5f5294d37e39169fe5678743f380d95c4e5a842
parent d022c23a

core/java/android/os/PowerManager.java

+7 −3
Original line number Diff line number Diff line
@@ -97,7 +97,8 @@ import android.util.Log; 
 *     </tbody>

 * </table>

 * 

 * 

 * Any application using a WakeLock must request the {@code android.permission.WAKE_LOCK}

 * permission in an {@code &lt;uses-permission&gt;} element of the application's manifest.

 */

public class PowerManager

{
@@ -188,8 +189,11 @@ public class PowerManager 
    

    /**

     * Class lets you say that you need to have the device on.

     *

     * <p>Call release when you are done and don't need the lock anymore.

     * <p>

     * Call release when you are done and don't need the lock anymore.

     * <p>

     * Any application using a WakeLock must request the {@code android.permission.WAKE_LOCK}

     * permission in an {@code &lt;uses-permission&gt;} element of the application's manifest.

     */

    public class WakeLock

    {

wifi/java/android/net/wifi/WifiManager.java

+5 −2
Original line number Diff line number Diff line
@@ -1193,16 +1193,19 @@ public class WifiManager { 
     * Acquiring a WifiLock will keep the radio on until the lock is released.  Multiple

     * applications may hold WifiLocks, and the radio will only be allowed to turn off when no

     * WifiLocks are held in any application.

     *

     * <p>

     * Before using a WifiLock, consider carefully if your application requires Wi-Fi access, or

     * could function over a mobile network, if available.  A program that needs to download large

     * files should hold a WifiLock to ensure that the download will complete, but a program whose

     * network usage is occasional or low-bandwidth should not hold a WifiLock to avoid adversely

     * affecting battery life.

     *

     * <p>

     * Note that WifiLocks cannot override the user-level "Wi-Fi Enabled" setting, nor Airplane

     * Mode.  They simply keep the radio from turning off when Wi-Fi is already on but the device

     * is idle.

     * <p>

     * Any application using a WifiLock must request the {@code android.permission.WAKE_LOCK}

     * permission in an {@code &lt;uses-permission&gt;} element of the application's manifest.

     */

    public class WifiLock {

        private String mTag;