Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit af469ac6 authored by Desh's avatar Desh
Browse files

Update App Function documentation

Flag: android.app.appfunctions.flags.enable_app_function_manager
Bug: 375121362
Test: N/A
Change-Id: I638d06b1cca52316c4d557e385e3ce1eead4f8cf
parent 9c9fefec
Loading
Loading
Loading
Loading
+8 −1
Original line number Diff line number Diff line
@@ -29,7 +29,14 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.Objects;

/** Represents an app function related errors. */
/**
 * Represents an app function related error.
 *
 * <p>This exception may include an {@link AppFunctionException#getExtras() Bundle}
 * containing additional error-specific metadata.
 *
 * <p>The AppFunction SDK can expose structured APIs by packing and unpacking this Bundle.
 */
@FlaggedApi(FLAG_ENABLE_APP_FUNCTION_MANAGER)
public final class AppFunctionException extends Exception implements Parcelable {
    /**
+10 −1
Original line number Diff line number Diff line
@@ -27,7 +27,16 @@ import android.os.Parcelable;

import java.util.Objects;

/** A request to execute an app function. */
/**
 * A request to execute an app function.
 *
 * <p>The {@link ExecuteAppFunctionRequest#getParameters()} contains the parameters for the function
 * to be executed in a GenericDocument. Structured classes defined in the AppFunction SDK can be
 * converted into GenericDocuments.
 *
 * <p>The {@link ExecuteAppFunctionRequest#getExtras()} provides any extra metadata for the request.
 * Structured APIs can be exposed in the SDK by packing and unpacking this Bundle.
 */
@FlaggedApi(FLAG_ENABLE_APP_FUNCTION_MANAGER)
public final class ExecuteAppFunctionRequest implements Parcelable {
    @NonNull
+10 −1
Original line number Diff line number Diff line
@@ -27,7 +27,16 @@ import android.os.Parcelable;

import java.util.Objects;

/** The response to an app function execution. */
/**
 * The response to an app function execution.
 *
 * <p>The {@link ExecuteAppFunctionResponse#getResultDocument()} contains the function's return
 * value as a GenericDocument. This can be converted back into a structured class using the
 * AppFunction SDK.
 *
 * <p>The {@link ExecuteAppFunctionResponse#getExtras()} provides any extra metadata returned by the
 * function. The AppFunction SDK can expose structured APIs by packing and unpacking this Bundle.
 */
@FlaggedApi(FLAG_ENABLE_APP_FUNCTION_MANAGER)
public final class ExecuteAppFunctionResponse implements Parcelable {
    @NonNull