#1335 feat: intent API to enable/disable/toggle a key map

Author: sds100

CHANGELOG.md

@@ -12,6 +12,7 @@
 - Show tips for parallel and sequence triggers, and constraints in the trigger screen
 - #397 enable/disable all key maps in a group
 - #1773 Option to show floating buttons on top of keyboard or notification panel.
+- #1335 Intent API to enable/disable/toggle a key map.
 
 ## Removed
 

api/src/main/AndroidManifest.xml

@@ -36,6 +36,16 @@
             </intent-filter>
         </receiver>
 
+        <receiver
+            android:name=".EnableKeyMapsBroadcastReceiver"
+            android:exported="true">
+            <intent-filter>
+                <action android:name="io.github.sds100.keymapper.ACTION_ENABLE_KEY_MAP" />
+                <action android:name="io.github.sds100.keymapper.ACTION_DISABLE_KEY_MAP" />
+                <action android:name="io.github.sds100.keymapper.ACTION_TOGGLE_KEY_MAP" />
+            </intent-filter>
+        </receiver>
+
         <!-- Don't require a permission because we want other apps to bind
          to this service. The permission wouldn't be signature-level so
          if a nefarious app wants to talk to Key Mapper they could add the permission anyway. -->

api/src/main/java/io/github/sds100/keymapper/api/Api.kt

@@ -4,9 +4,13 @@ object Api {
     // Do not use the package name for debug/ci builds
     const val ACTION_TRIGGER_KEYMAP_BY_UID =
         "io.github.sds100.keymapper.ACTION_TRIGGER_KEYMAP_BY_UID"
-    const val EXTRA_KEYMAP_UID = "io.github.sds100.keymapper.EXTRA_KEYMAP_UID"
+    const val EXTRA_KEYMAP_ID = "io.github.sds100.keymapper.EXTRA_KEYMAP_UID"
 
     const val ACTION_PAUSE_MAPPINGS = "io.github.sds100.keymapper.ACTION_PAUSE_MAPPINGS"
     const val ACTION_RESUME_MAPPINGS = "io.github.sds100.keymapper.ACTION_RESUME_MAPPINGS"
     const val ACTION_TOGGLE_MAPPINGS = "io.github.sds100.keymapper.ACTION_TOGGLE_MAPPINGS"
+
+    const val ACTION_ENABLE_KEY_MAP = "io.github.sds100.keymapper.ACTION_ENABLE_KEY_MAP"
+    const val ACTION_DISABLE_KEY_MAP = "io.github.sds100.keymapper.ACTION_DISABLE_KEY_MAP"
+    const val ACTION_TOGGLE_KEY_MAP = "io.github.sds100.keymapper.ACTION_TOGGLE_KEY_MAP"
 }

api/src/main/java/io/github/sds100/keymapper/api/EnableKeyMapsBroadcastReceiver.kt

@@ -0,0 +1,36 @@
+package io.github.sds100.keymapper.api
+
+import android.content.BroadcastReceiver
+import android.content.Context
+import android.content.Intent
+import dagger.hilt.android.AndroidEntryPoint
+import io.github.sds100.keymapper.base.keymaps.EnableKeyMapsUseCase
+import javax.inject.Inject
+
+// DON'T MOVE THIS CLASS TO A DIFFERENT PACKAGE OR RENAME BECAUSE IT BREAKS THE API
+@AndroidEntryPoint
+class EnableKeyMapsBroadcastReceiver : BroadcastReceiver() {
+
+    @Inject
+    lateinit var useCase: EnableKeyMapsUseCase
+
+    override fun onReceive(context: Context?, intent: Intent?) {
+        context ?: return
+        intent?.action ?: return
+
+        if (intent.action != Api.ACTION_ENABLE_KEY_MAP &&
+            intent.action != Api.ACTION_DISABLE_KEY_MAP &&
+            intent.action != Api.ACTION_TOGGLE_KEY_MAP
+        ) {
+            return
+        }
+
+        val keyMapUid = intent.getStringExtra(Api.EXTRA_KEYMAP_ID) ?: return
+
+        when (intent.action) {
+            Api.ACTION_ENABLE_KEY_MAP -> useCase.enable(keyMapUid)
+            Api.ACTION_DISABLE_KEY_MAP -> useCase.disable(keyMapUid)
+            Api.ACTION_TOGGLE_KEY_MAP -> useCase.toggle(keyMapUid)
+        }
+    }
+}

api/src/main/java/io/github/sds100/keymapper/api/LaunchKeyMapShortcutActivity.kt

@@ -33,8 +33,8 @@ class LaunchKeyMapShortcutActivity : ComponentActivity() {
                     Intent(Api.ACTION_TRIGGER_KEYMAP_BY_UID).apply {
                         setPackage(packageName)
 
-                        val uuid = intent.getStringExtra(Api.EXTRA_KEYMAP_UID)
-                        putExtra(Api.EXTRA_KEYMAP_UID, uuid)
+                        val uuid = intent.getStringExtra(Api.EXTRA_KEYMAP_ID)
+                        putExtra(Api.EXTRA_KEYMAP_ID, uuid)
 
                         sendBroadcast(this)
                     }

api/src/main/java/io/github/sds100/keymapper/api/PauseMappingsBroadcastReceiver.kt

@@ -8,7 +8,7 @@ import io.github.sds100.keymapper.base.keymaps.PauseKeyMapsUseCase
 import io.github.sds100.keymapper.common.utils.firstBlocking
 import javax.inject.Inject
 
-// DON'T MOVE THIS CLASS TO A DIFFERENT PACKAGE BECAUSE IT BREAKS THE API
+// DON'T MOVE THIS CLASS TO A DIFFERENT PACKAGE OR RENAME BECAUSE IT BREAKS THE API
 @AndroidEntryPoint
 class PauseMappingsBroadcastReceiver : BroadcastReceiver() {
 

api/src/main/java/io/github/sds100/keymapper/api/TriggerKeyMapsBroadcastReceiver.kt

@@ -26,7 +26,7 @@ class TriggerKeyMapsBroadcastReceiver : BroadcastReceiver() {
 
         when (intent.action) {
             Api.ACTION_TRIGGER_KEYMAP_BY_UID -> {
-                intent.getStringExtra(Api.EXTRA_KEYMAP_UID)?.let { uid ->
+                intent.getStringExtra(Api.EXTRA_KEYMAP_ID)?.let { uid ->
                     coroutineScope.launch {
                         serviceAdapter.send(TriggerKeyMapEvent(uid))
                     }

base/src/main/assets/whats-new.txt

@@ -1,13 +1,11 @@
-Version 4.0! 🎉
-
 📲 You can now remap buttons when the screen is off for FREE using PRO mode!
 
-Remap your power button and more
+Remap your power button and more!
 
-Enable/disable all the key maps in a group
+Enable/disable all the key maps in a group. Intent API to enable/disable/toggle a key map.
 
-Option to show floating buttons on top of keyboard or notification panel
+Option to show floating buttons on top of keyboard or notification panel.
 
-Many other bug fixes and optimisations
+Many other bug fixes and optimisations.
 
-See all the changes at http://changelog.keymapper.club.
+See all the changes at http://changelog.keymapper.club

base/src/main/java/io/github/sds100/keymapper/base/BaseSingletonHiltModule.kt

@@ -18,6 +18,8 @@ import io.github.sds100.keymapper.base.input.InputEventHub
 import io.github.sds100.keymapper.base.input.InputEventHubImpl
 import io.github.sds100.keymapper.base.keymaps.ConfigKeyMapState
 import io.github.sds100.keymapper.base.keymaps.ConfigKeyMapStateImpl
+import io.github.sds100.keymapper.base.keymaps.EnableKeyMapsUseCase
+import io.github.sds100.keymapper.base.keymaps.EnableKeyMapsUseCaseImpl
 import io.github.sds100.keymapper.base.keymaps.FingerprintGesturesSupportedUseCase
 import io.github.sds100.keymapper.base.keymaps.FingerprintGesturesSupportedUseCaseImpl
 import io.github.sds100.keymapper.base.keymaps.GetDefaultKeyMapOptionsUseCase
@@ -164,4 +166,8 @@ abstract class BaseSingletonHiltModule {
     @Binds
     @Singleton
     abstract fun bindSwitchImeInterface(impl: SwitchImeAsyncImpl): SwitchImeInterface
+
+    @Binds
+    @Singleton
+    abstract fun bindEnableKeyMapsUseCase(impl: EnableKeyMapsUseCaseImpl): EnableKeyMapsUseCase
 }

base/src/main/java/io/github/sds100/keymapper/base/keymaps/EnableKeyMapsUseCase.kt

@@ -0,0 +1,29 @@
+package io.github.sds100.keymapper.base.keymaps
+
+import io.github.sds100.keymapper.data.repositories.KeyMapRepository
+import javax.inject.Inject
+import javax.inject.Singleton
+
+@Singleton
+class EnableKeyMapsUseCaseImpl @Inject constructor(
+    private val keyMapRepository: KeyMapRepository
+) : EnableKeyMapsUseCase {
+
+    override fun enable(uid: String) {
+        keyMapRepository.enableById(uid)
+    }
+
+    override fun toggle(uid: String) {
+        keyMapRepository.toggleById(uid)
+    }
+
+    override fun disable(uid: String) {
+        keyMapRepository.disableById(uid)
+    }
+}
+
+interface EnableKeyMapsUseCase {
+    fun enable(uid: String)
+    fun toggle(uid: String)
+    fun disable(uid: String)
+}