Skip to content

ChatApp

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

ChatApp

README.md

AppFunctions API sample

A sample Android application demonstrating the usage of AppFunctions to provide application functionality to system services and agents.

This sample is a chat application built with Jetpack Compose and Hilt.

Features

  • AppFunctions Integration: Provides core chat capabilities (sending messages, retrieving contacts, and making calls) via AppFunctions.
  • Modern Android Architecture: Built using Kotlin, Compose, and Hilt.

Getting Started

  1. Clone the repository.
  2. Open the project in Android Studio.
  3. Build and run the app on an emulator or device.

AppFunctions

This sample demonstrates how to define and provide the following AppFunctions in AppFunctions.kt:

  • searchContacts(query: String, filterType: String): Search for contacts or groups. filterType must be "INDIVIDUAL" or "GROUP".
  • send(name: String, endpointValue: String, messageBody: String, imageUri: Uri? = null): Sends a message to a recipient.
  • makeCall(contactName: String? = null, endpointValue: String? = null): Initiates a call to a recipient.

These functions are annotated with @AppFunction, allowing them to be discovered and executed by the system.

AppFunctionSerializable

The sample demonstrates using @AppFunctionSerializable to provide custom data types to AppFunctions. The following data classes are annotated with @AppFunctionSerializable:

  • ContactSearchResult: Represents a contact search result.
  • Result: The result of a message sending operation.
  • Recipient: Represents a recipient of a message.
  • ChatGroup: Represents a group of recipients.

Verifying AppFunctions Behavior

You can verify the behavior of the provided AppFunctions using the adb shell cmd app_function tool.

For example, to execute the send function and simulate a system agent sending a message, run the following command in your terminal while the app is installed on an emulator or connected device:

adb shell "cmd app_function execute-app-function \
  --package com.example.chatapp \
  --function 'com.example.chatapp.appfunctions.AppFunctions#send' \
  --parameters '{\"name\": \"Alice\", \"endpointValue\": \"1\", \"messageBody\": \"Hello Alice!\"}'"

This will trigger the send AppFunction in the background, executing your sending logic natively.

To search for contacts:

adb shell "cmd app_function execute-app-function \
  --package com.example.chatapp \
  --function 'com.example.chatapp.appfunctions.AppFunctions#searchContacts' \
  --parameters '{\"query\": \"Alice\", \"filterType\": \"INDIVIDUAL\"}'"

License

Copyright 2026 The Android Open Source Project

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.