Skip to content

Commit bf0856f

Browse files
committed
docs: document Intent API to enable/disable/toggle a key map.
1 parent 8a184d4 commit bf0856f

File tree

2 files changed

+41
-2
lines changed

2 files changed

+41
-2
lines changed

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 & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ There are many ways to pause and resume your mappings. These are very useful fea
88

99
![](../images/pause-keymaps-quick-settings.png)
1010

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

1313
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
1414

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

3636
```
3737
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
3873
```

0 commit comments

Comments
 (0)