Capability Registry

The full table of standard library `CapabilityIds` plus the app-specific range. Every ID below is from

dev.ketoy.capabilities.core.CapabilityIds (or the navigation / runtime modules where noted).

For the what and why, see the guides (Networking, DataStore, Room, Navigation, Custom Capability). This page is the what in table form.

ID ranges

APP_SPECIFIC_START = 0x4000. KBCRoomBridge enforces id >= 0x4000 on all three registration helpers (suspendCapability, flowCapability, syncCapability).

Network (0x0500–0x05FF)

Registered by CapabilityRegistry.registerNetworkCapabilities(client), which is called transitively by registerCoreCapabilities(...).

Storage — KV (0x0600–0x0605)

Registered by registerCoreCapabilities(...) when you pass a DataStore<Preferences>.

Supported value types: String, Int, Long, Float, Double, Boolean. Anything else throws KetoyException on KV_SET.

Storage — Room (0x0610–0x0614)

Generic IDs. Typed Room operations are app-specific (0x4000+) via KBCRoomBridge.

In practice, prefer KBCRoomBridge + per-operation app-specific IDs.

Navigation (0x0700–0x0708)

Registered by CapabilityRegistry.registerNavigationCapabilities(navigator) from dev.ketoy.vm:ketoy-capabilities-navigation.

Platform (0x0900–0x090A)

Registered by registerPlatformCapabilities(context, analyticsTracker?).

VIBRATE requires the host APK to declare <uses-permission android:name="android.permission.VIBRATE" />. REQUEST_PERMISSION requires the activity to inherit androidx.activity.ComponentActivity (which KetoyScreen's host already does).

ViewModel state (0x0A00–0x0A03)

Registered by registerViewModelStateCapabilities(viewModel) — done automatically by KetoyScreen when it instantiates a KetoyVirtualViewModel.

Dispatchers (0x0B00–0x0B03)

Registered by registerDispatcherCapabilities().

Used as the dispatcher argument to WITH_CONTEXT opcodes.

Flow operators (0x0C00–0x0C08)

Registered by registerFlowCapabilities(flowEngine).

These don't usually appear in KBC source directly — the compiler recognises .map { }, .filter { }, etc. and lowers them onto these IDs through KBCFlowEngine.

registerCoreCapabilities(...) — one-stop bootstrap

fun CapabilityRegistry.registerCoreCapabilities(
    context: Context,
    dataStore: DataStore<Preferences>? = null,
    httpClient: KetoyHttpClient = KetoyHttpClient.build(),
    analyticsTracker: (String, Map<String, Any?>) -> Unit = { _, _ -> }
)

Registers, in order:

1. Network (always).
2. Storage KV (only if dataStore != null).
3. Platform (always; analytics tracker is optional).
4. Dispatchers (always).

Not registered by registerCoreCapabilities:

• Navigation — call registerNavigationCapabilities(navigator).
• ViewModel state — registered by KetoyVirtualViewModel.
• Flow operators — registered by KetoyVM against its KBCFlowEngine.
• Room — register per-DAO via KBCRoomBridge.

Capability JSON schema

{
  "version": 1,
  "allowedStdlibFqNames": [ "kotlin.let", "kotlin.collections.listOf", ... ],
  "capabilities": [
    {
      "id": 16384,
      "name": "OBSERVE_TODOS",
      "fqName": "com.example.myapp.ketoyscreens.observeTodos",
      "kind": "FLOW",
      "parameterTypes": [],
      "returnType": "kotlinx.coroutines.flow.Flow"
    }
  ]
}

The compiler reads this at build time to validate each @KetoyCapabilityStub's ID and signature.

Next: Compose Adapters →