Integrate Figranium with Android AppFunctions and system assistants

​

Install the integration

plugins {
    id("com.google.devtools.ksp") version "2.2.20-2.0.3"
}

dependencies {
    implementation("dev.figranium:figranium-appfunctions:0.1.0")
    ksp("androidx.appfunctions:appfunctions-compiler:1.0.0-alpha10")
}

​

Configure the client provider

import android.app.Application
import dev.figranium.sdk.Figranium
import dev.figranium.sdk.FigraniumAuthentication
import dev.figranium.sdk.appfunctions.FigraniumAppFunctionConfiguration
import dev.figranium.sdk.appfunctions.FigraniumAppFunctionClientProvider
import dev.figranium.sdk.appfunctions.FigraniumAppFunctions

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        FigraniumAppFunctionConfiguration.configure(
            FigraniumAppFunctionClientProvider {
                Figranium(
                    baseUrl = "https://api.figranium.example.com",
                    authentication = FigraniumAuthentication.ApiKey(loadKeyFromKeystore()),
                )
            }
        )

        FigraniumAppFunctions.configure(setOf("lookup-order", "check-inventory"))
        // Enable the generated AppFunction when ready
        // lifecycleScope.launch { FigraniumAppFunctions.setEnabled(this@MyApplication, enabled = true) }
    }
}

​

Service and available AppFunction

​

BaseFigraniumAppFunctionService

@RequiresApi(36)
@AppFunctionServiceEntryPoint(
    serviceName = "FigraniumAppFunctionService",
    appFunctionXmlFileName = "figranium_app_functions"
)
abstract class BaseFigraniumAppFunctionService : AppFunctionService()

• The @AppFunction method is declared with isEnabled = false. It is disabled by default.
• The service requires API 36 at runtime.

​

runFigraniumTask

@AppFunction(isEnabled = false, isDescribedByKDoc = true)
suspend fun runFigraniumTask(parameters: RunFigraniumTaskParameters): FigraniumAppFunctionResult

• Parameter: RunFigraniumTaskParameters with a single taskId field, the ID of an app-approved deterministic task.
• Returns: FigraniumAppFunctionResult containing:
  • outcome (String): the Figranium execution outcome such as success or error. Falls back to unknown when the server omits it.
  • data (String?): JSON output from the approved task.
  • runId (String?): the run ID, if returned by Figranium.
• HTTP endpoint: POST /tasks/{id}/api (via client.runTask<JsonObject>(taskId))

​

Data types

@AppFunctionSerializable
data class RunFigraniumTaskParameters(
    val taskId: String,
)

@AppFunctionSerializable
data class FigraniumAppFunctionResult(
    val outcome: String,
    val data: String? = null,
    val runId: String? = null,
)

​

Control the task allowlist and availability

FigraniumAppFunctions.configure(setOf("lookup-order", "check-inventory"))

• Only task IDs present in the configured set can be executed through AppFunctions.
• Calling runFigraniumTask with a task ID outside the allowlist throws an IllegalStateException with the message: This task is not approved for AppFunctions execution.

​

Enable or disable the AppFunction

// In a coroutine scope, such as lifecycleScope
FigraniumAppFunctions.setEnabled(context, enabled = true)

• setEnabled is safe to call on devices below API 36 (it returns immediately with no effect).
• When enabled, the generated AppFunction becomes discoverable by Android assistants and agents.

​

Security notes

• Keep API keys in Android Keystore-backed storage or another secure app-owned store. Never pass credentials as AppFunction parameters.
• The allowlist means an assistant can run only the tasks your app explicitly approves. It cannot create arbitrary browser actions or read Figranium credentials.
• If the provider throws, the exception propagates through the AppFunction runtime.

​

Error reference