Add AppFunction Execution API [ExecuteAppFunctionRequest] (2d355cfb) · Commits · e / os / android_frameworks_base

core/api/current.txt

+24 −0

Original line number	Diff line number	Diff line
		@@ -8718,6 +8718,30 @@ package android.app.admin {

		}

		package android.app.appfunctions {

		@FlaggedApi("android.app.appfunctions.flags.enable_app_function_manager") public final class AppFunctionManager {
		}

		@FlaggedApi("android.app.appfunctions.flags.enable_app_function_manager") public final class ExecuteAppFunctionRequest implements android.os.Parcelable {
		method public int describeContents();
		method @NonNull public android.os.Bundle getExtras();
		method @NonNull public String getFunctionIdentifier();
		method @NonNull public android.app.appsearch.GenericDocument getParameters();
		method @NonNull public String getTargetPackageName();
		method public void writeToParcel(@NonNull android.os.Parcel, int);
		field @NonNull public static final android.os.Parcelable.Creator<android.app.appfunctions.ExecuteAppFunctionRequest> CREATOR;
		}

		public static final class ExecuteAppFunctionRequest.Builder {
		ctor public ExecuteAppFunctionRequest.Builder(@NonNull String, @NonNull String);
		method @NonNull public android.app.appfunctions.ExecuteAppFunctionRequest build();
		method @NonNull public android.app.appfunctions.ExecuteAppFunctionRequest.Builder setExtras(@NonNull android.os.Bundle);
		method @NonNull public android.app.appfunctions.ExecuteAppFunctionRequest.Builder setParameters(@NonNull android.app.appsearch.GenericDocument);
		}

		}

		package android.app.assist {

		public class AssistContent implements android.os.Parcelable {

core/java/android/app/appfunctions/AppFunctionManager.java

+4 −1

Original line number	Diff line number	Diff line
		@@ -16,6 +16,9 @@

		package android.app.appfunctions;

		import static android.app.appfunctions.flags.Flags.FLAG_ENABLE_APP_FUNCTION_MANAGER;

		import android.annotation.FlaggedApi;
		import android.annotation.SystemService;
		import android.content.Context;

		@@ -25,8 +28,8 @@ import android.content.Context;
		* <p>App function is a specific piece of functionality that an app offers to the system. These
		* functionalities can be integrated into various system features.
		*
		* @hide
		*/
		@FlaggedApi(FLAG_ENABLE_APP_FUNCTION_MANAGER)
		@SystemService(Context.APP_FUNCTION_SERVICE)
		public final class AppFunctionManager {
		private final IAppFunctionManager mService;

core/java/android/app/appfunctions/ExecuteAppFunctionRequest.aidl

0 → 100644

+21 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2024 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
		*
		* http://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.
		*/

		package android.app.appfunctions;

		import android.app.appfunctions.ExecuteAppFunctionRequest;

		parcelable ExecuteAppFunctionRequest;
		No newline at end of file

core/java/android/app/appfunctions/ExecuteAppFunctionRequest.java

0 → 100644

+189 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2024 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
		*
		* http://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.
		*/

		package android.app.appfunctions;


		import static android.app.appfunctions.flags.Flags.FLAG_ENABLE_APP_FUNCTION_MANAGER;

		import android.annotation.FlaggedApi;
		import android.annotation.NonNull;
		import android.app.appsearch.GenericDocument;
		import android.os.Bundle;
		import android.os.Parcel;
		import android.os.Parcelable;

		import java.util.Objects;

		/**
		* A request to execute an app function.
		*/
		@FlaggedApi(FLAG_ENABLE_APP_FUNCTION_MANAGER)
		public final class ExecuteAppFunctionRequest implements Parcelable {
		@NonNull
		public static final Creator<ExecuteAppFunctionRequest> CREATOR =
		new Creator<>() {
		@Override
		public ExecuteAppFunctionRequest createFromParcel(Parcel parcel) {
		String targetPackageName = parcel.readString8();
		String functionIdentifier = parcel.readString8();
		GenericDocument parameters;
		parameters = GenericDocument.createFromParcel(parcel);
		Bundle extras = parcel.readBundle(Bundle.class.getClassLoader());
		return new ExecuteAppFunctionRequest(
		targetPackageName, functionIdentifier, extras, parameters);
		}

		@Override
		public ExecuteAppFunctionRequest[] newArray(int size) {
		return new ExecuteAppFunctionRequest[size];
		}
		};
		/**
		* Returns the package name of the app that hosts the function.
		*/
		@NonNull
		private final String mTargetPackageName;
		/**
		* Returns the unique string identifier of the app function to be executed.
		* TODO(b/357551503): Document how callers can get the available function identifiers.
		*/
		@NonNull
		private final String mFunctionIdentifier;
		/**
		* Returns additional metadata relevant to this function execution request.
		*/
		@NonNull
		private final Bundle mExtras;
		/**
		* Returns the parameters required to invoke this function. Within this [GenericDocument],
		* the property names are the names of the function parameters and the property values are the
		* values of those parameters.
		*
		* <p>The document may have missing parameters. Developers are advised to implement defensive
		* handling measures.
		*
		* TODO(b/357551503): Document how function parameters can be obtained for function execution
		*/
		@NonNull
		private final GenericDocument mParameters;

		private ExecuteAppFunctionRequest(
		@NonNull String targetPackageName,
		@NonNull String functionIdentifier,
		@NonNull Bundle extras,
		@NonNull GenericDocument parameters) {
		mTargetPackageName = Objects.requireNonNull(targetPackageName);
		mFunctionIdentifier = Objects.requireNonNull(functionIdentifier);
		mExtras = Objects.requireNonNull(extras);
		mParameters = Objects.requireNonNull(parameters);
		}

		/**
		* Returns the package name of the app that hosts the function.
		*/
		@NonNull
		public String getTargetPackageName() {
		return mTargetPackageName;
		}

		/**
		* Returns the unique string identifier of the app function to be executed.
		*/
		@NonNull
		public String getFunctionIdentifier() {
		return mFunctionIdentifier;
		}

		/**
		* Returns the function parameters. The key is the parameter name, and the value is the
		* parameter value.
		* <p>
		* The bundle may have missing parameters. Developers are advised to implement defensive
		* handling measures.
		*/
		@NonNull
		public GenericDocument getParameters() {
		return mParameters;
		}

		/**
		* Returns the additional data relevant to this function execution.
		*/
		@NonNull
		public Bundle getExtras() {
		return mExtras;
		}

		@Override
		public void writeToParcel(@NonNull Parcel dest, int flags) {
		dest.writeString8(mTargetPackageName);
		dest.writeString8(mFunctionIdentifier);
		mParameters.writeToParcel(dest, flags);
		dest.writeBundle(mExtras);
		}

		@Override
		public int describeContents() {
		return 0;
		}

		/**
		* Builder for {@link ExecuteAppFunctionRequest}.
		*/
		public static final class Builder {
		@NonNull
		private final String mTargetPackageName;
		@NonNull
		private final String mFunctionIdentifier;
		@NonNull
		private Bundle mExtras = Bundle.EMPTY;
		@NonNull
		private GenericDocument mParameters = new GenericDocument.Builder<>("", "", "").build();

		public Builder(@NonNull String targetPackageName, @NonNull String functionIdentifier) {
		mTargetPackageName = Objects.requireNonNull(targetPackageName);
		mFunctionIdentifier = Objects.requireNonNull(functionIdentifier);
		}

		/**
		* Sets the additional data relevant to this function execution.
		*/
		@NonNull
		public Builder setExtras(@NonNull Bundle extras) {
		mExtras = Objects.requireNonNull(extras);
		return this;
		}

		/**
		* Sets the function parameters.
		*/
		@NonNull
		public Builder setParameters(@NonNull GenericDocument parameters) {
		mParameters = Objects.requireNonNull(parameters);
		return this;
		}

		/**
		* Builds the {@link ExecuteAppFunctionRequest}.
		*/
		@NonNull
		public ExecuteAppFunctionRequest build() {
		return new ExecuteAppFunctionRequest(
		mTargetPackageName, mFunctionIdentifier, mExtras, mParameters);
		}
		}
		}