Skip to content

Commit f388572

Browse files
committed
Merge branch 'develop'
2 parents a05806f + bf0856f commit f388572

File tree

4 files changed

+44
-8
lines changed

4 files changed

+44
-8
lines changed

docs/contributing/codebase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Key Mapper is becoming a very complex application with FOSS and closed source co
1010
- `base`: This contains the majority of the Key Mapper code and all the user interface code.
1111
- `common`: Utility classes used across many modules.
1212
- `data`: The persistance layer, the Room database and preferences. The data schema is defined here, including for closed source components.
13-
- `shizuku`: The Key Mapper implementation of Shizuku so that we can present our own user interface for setting up Shizuku without their app.
13+
- `priv`: "priv" as in priviledged. The Key Mapper implementation of Shizuku so that we can present our own user interface for setting up Shizuku without their app. This module effectively grants Key Mapper priviledged system permissions that normal apps can not acquire.
1414
- `system`: All the adapters for interacting with the Android framework. All key map actions ultimately call the code here.
1515
- `systemstubs`: Stubs for hidden system APIs. This contains AIDL files as well as manually written Java stubs if the AIDL file would clash with an SDK file.
1616

docs/user-guide/api.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@ Read more [here](../keymaps#trigger-from-other-apps-230).
66

77
### Pausing and resuming your key maps (2.3.0+)
88

9-
Read more [here](../controlling-mappings#intent-api-230).
9+
Read more [here](../controlling-mappings).
10+
11+
### Enabling and disabling your key maps (4.0.0+)
12+
13+
Read more [here](../controlling-mappings).

docs/user-guide/controlling-mappings.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
There are many ways to pause and resume your mappings. These are very useful features because they allow to easily turn off your key maps if you don't need to use them.
22

3-
### Press the button in the home screen menu
4-
![](../images/home-menu.png)
5-
63
### Use the notification
74

85
![](../images/notification-toggle-mappings.png)
@@ -11,7 +8,7 @@ There are many ways to pause and resume your mappings. These are very useful fea
118

129
![](../images/pause-keymaps-quick-settings.png)
1310

14-
### Intent API (2.3.0+)
11+
### Pause/resume key maps with the Intent API (2.3.0+)
1512

1613
This will allow other apps to pause and resume your mappings by broadcasting an Intent to Key Mapper. The properties for the Intent are shown below
1714

@@ -38,4 +35,39 @@ Add `.debug` or `.ci` to the end of the package name if you are using a debug or
3835

3936
```
4037
io.github.sds100.keymapper.api.PauseMappingsBroadcastReceiver
38+
```
39+
40+
### Enable/disable key maps with the Intent API (4.0.0+)
41+
42+
This will allow other apps to enable and disable a key map by broadcasting an Intent to Key Mapper. The properties for the Intent are shown below
43+
44+
#### Action (choose one)
45+
```
46+
io.github.sds100.keymapper.ACTION_ENABLE_KEY_MAP
47+
```
48+
```
49+
io.github.sds100.keymapper.ACTION_DISABLE_KEY_MAP
50+
```
51+
```
52+
io.github.sds100.keymapper.ACTION_TOGGLE_KEY_MAP
53+
```
54+
55+
### String extra (mandatory)
56+
57+
```
58+
io.github.sds100.keymapper.EXTRA_KEYMAP_UID
59+
```
60+
61+
#### Package
62+
63+
```
64+
io.github.sds100.keymapper
65+
```
66+
67+
Add `.debug` or `.ci` to the end of the package name if you are using a debug or ci build of Key Mapper.
68+
69+
#### Class
70+
71+
```
72+
io.github.sds100.keymapper.api.EnableKeyMapsBroadcastReceiver
4173
```

requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
mkdocs-material==9.5.26
2-
mkdocs-redirects==1.2.1
1+
mkdocs-material==9.6.22
2+
mkdocs-redirects==1.2.2

0 commit comments

Comments
 (0)