AppFunctionAppMetadata

Artifact: androidx.appfunctions:appfunctions

Kotlin |Java

class AppFunctionAppMetadata

Metadata describing how an app exposes its functions for use by an AI agent or large language model (LLM).

This class corresponds to the androidx.appfunctions.R.styleable.AppFunctionAppMetadata styleable in the XML linked to property android.app.appfunctions.app_metadata in the app's manifest.

Summary

Public constructors
`AppFunctionAppMetadata(instructions: String, displayDescription: String)`

Public functions
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open String`	`toString()`

Public properties
`String`	`displayDescription` A short, user-visible description of what the app functions enable the agent to do.
`String`	`instructions` App-provided instructions for the LLM on how to use the app's functions together.

Public constructors

AppFunctionAppMetadata

Added in 1.0.0-beta01

AppFunctionAppMetadata(
    instructions: String = "",
    displayDescription: String = ""
)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

displayDescription

Added in 1.0.0-beta01

val displayDescription: String

A short, user-visible description of what the app functions enable the agent to do.

Corresponds to the displayDescription attribute in the androidx.appfunctions.R.styleable.AppFunctionAppMetadata styleable. Defaults to empty string if not specified.

instructions

Added in 1.0.0-beta01

val instructions: String

App-provided instructions for the LLM on how to use the app's functions together.

Agents should use these instructions as context when planning calls to the app's functions, for example to follow a required order across functions (such as searching for an entity before updating or deleting it) or to respect constraints that apply across functions. Instructions complement, and do not replace, the descriptions of individual functions.

Corresponds to the instructions attribute in the androidx.appfunctions.R.styleable.AppFunctionAppMetadata styleable. Defaults to empty string if not specified.