AppFunctionManager Class

Definition

[Android.Runtime.Register("android/app/appfunctions/AppFunctionManager", ApiSince=36, DoNotGenerateAcw=true)]
public sealed class AppFunctionManager : Java.Lang.Object

[<Android.Runtime.Register("android/app/appfunctions/AppFunctionManager", ApiSince=36, DoNotGenerateAcw=true)>]
type AppFunctionManager = class
    inherit Object

Inheritance

Object

Object

AppFunctionManager

Attributes

RegisterAttribute

Remarks

Provides access to App Functions. App Functions is currently a beta/experimental preview feature.

An app function is a piece of functionality that apps expose to the system for cross-app orchestration.

<h3>Building App Functions</h3>

Most developers should build app functions through the AppFunctions SDK. This SDK library offers a more convenient and type-safe way to build app functions. The SDK provides predefined function schemas for common use cases and associated data classes for function parameters and return values. Apps only have to implement the provided interfaces. Internally, the SDK converts these data classes into ExecuteAppFunctionRequest#getParameters() and ExecuteAppFunctionResponse#getResultDocument().

<h3>Discovering App Functions</h3>

When there is a package change or the device starts up, the metadata of available functions is indexed on-device by AppSearchManager. AppSearch stores the indexed information as an AppFunctionStaticMetadata document. This document contains the functionIdentifier and the schema information that the app function implements. This allows other apps and the app itself to discover these functions using the AppSearch search APIs. Visibility to this metadata document is based on the packages that have visibility to the app providing the app functions. AppFunction SDK provides a convenient way to achieve this and is the preferred method.

<h3>Executing App Functions</h3>

To execute an app function, the caller app can retrieve the functionIdentifier from the AppFunctionStaticMetadata document and use it to build an ExecuteAppFunctionRequest. Then, invoke #executeAppFunction with the request to execute the app function. Callers need the android.permission.EXECUTE_APP_FUNCTIONS permission to execute app functions from other apps. An app can always execute its own app functions and doesn't need these permissions. AppFunction SDK provides a convenient way to achieve this and is the preferred method.

<h3>Example</h3>

An assistant app is trying to fulfill the user request "Save XYZ into my note". The assistant app should first list all available app functions as AppFunctionStaticMetadata documents from AppSearch. Then, it should identify an app function that implements the CreateNote schema. Finally, the assistant app can invoke #executeAppFunction with the functionIdentifier of the chosen function.

Java documentation for android.app.appfunctions.AppFunctionManager.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.