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

Commit 1c9e5a99 authored by Matt Pietal's avatar Matt Pietal
Browse files

More keyguard docs 

Starting to set the template for docs, with much more coming.

Test: read the docs
Bug: 195430376
Change-Id: Ie0403bba608520d2be6a5b5d4555c6e8a3deb1ed
parent 635fef18

packages/SystemUI/docs/keyguard.md

+34 −0
Original line number Diff line number Diff line
@@ -8,5 +8,39 @@ Keyguard is responsible for: 


Keyguard is the first screen available when turning on the device, as long as the user has not specified a security method of NONE.



## Critical User Journeys



The journeys below generally refer to Keyguard's portion of the overall flow, especially regarding use of the power button. Power button key interpretation (short press, long press, very long press, multi press) is done in [PhoneWindowManager][4], with calls to [PowerManagerService][2] to sleep or wake up, if needed.



### Power On - AOD enabled or disabled



Begins with the device in low power mode, with the display active for [AOD][3] or inactive. [PowerManagerService][2] can be directed to wake up on various user-configurable signals, such as lift to wake, screen taps, among others. [AOD][2], whether visibly enabled or not, handles these signals to transition AOD to full Lockscreen content. See more in [AOD][3].



### Power Off



An indication to power off the device most likely comes from one of two signals: the user presses the power button or the screen timeout has passed. This may [lock the device](#How-the-device-locks)



#### On Lockscreen



#### On Lockscreen, occluded by an activity



#### Device unlocked, Keyguard has gone away



### Pulsing (Incoming notifications while dozing)



### How the device locks



More coming

* Screen timeout

* Smart lock

* Device policy

* Power button instantly locks setting

* Lock timeout after screen timeout setting





[1]: /frameworks/base/packages/SystemUI/docs/keyguard/bouncer.md

[2]: /frameworks/base/services/core/java/com/android/server/power/PowerManagerService.java

[3]: /frameworks/base/packages/SystemUI/docs/keyguard/aod.md

[4]: /frameworks/base/services/core/java/com/android/server/policy/PhoneWindowManager.java

packages/SystemUI/docs/keyguard/aod.md

0 → 100644
+1 −0
Original line number Diff line number Diff line 
# Always-on Display (AOD)

packages/SystemUI/docs/keyguard/bouncer.md

+3 −3

File changed.

Contains only whitespace changes.