AppFunctionMetadata


public final class AppFunctionMetadata


Represents an AppFunction's metadata.

The class provides the essential information to call an AppFunction. The caller has two options to invoke a function:

  • Using function schema to identify input/output: The function schema defines the input and output of a function. If schema is not null, the caller can look up the input/output information based on the schema definition, and call the function accordingly.

  • Examine parameters and response: A function metadata also has parameters and response properties describe the input and output of a function. The caller can examine these fields to obtain the input/output information, and call the function accordingly.

Summary

Public constructors

AppFunctionMetadata(
    @NonNull String id,
    @NonNull String packageName,
    boolean isEnabled,
    AppFunctionSchemaMetadata schema,
    @NonNull List<@NonNull AppFunctionParameterMetadata> parameters,
    @NonNull AppFunctionResponseMetadata response,
    @NonNull AppFunctionComponentsMetadata components
)

Public methods

boolean
equals(Object other)
final @NonNull AppFunctionComponentsMetadata

Reusable components that could be shared within the function specification.

final @NonNull String

The ID used in an androidx.appfunctions.ExecuteAppFunctionRequest to refer to this AppFunction.

final @NonNull String

The package name of the Android app called to execute the app function.

final @NonNull List<@NonNull AppFunctionParameterMetadata>

The parameters of the AppFunction.

final @NonNull AppFunctionResponseMetadata

The response of the AppFunction.

final AppFunctionSchemaMetadata

The predefined schema of the AppFunction.

int
final boolean

Indicates whether the function is enabled currently or not.

@NonNull String

Public constructors

AppFunctionMetadata

Added in 1.0.0-alpha01
public AppFunctionMetadata(
    @NonNull String id,
    @NonNull String packageName,
    boolean isEnabled,
    AppFunctionSchemaMetadata schema,
    @NonNull List<@NonNull AppFunctionParameterMetadata> parameters,
    @NonNull AppFunctionResponseMetadata response,
    @NonNull AppFunctionComponentsMetadata components
)

Public methods

equals

public boolean equals(Object other)

getComponents

Added in 1.0.0-alpha01
public final @NonNull AppFunctionComponentsMetadata getComponents()

Reusable components that could be shared within the function specification.

getId

Added in 1.0.0-alpha01
public final @NonNull String getId()

The ID used in an androidx.appfunctions.ExecuteAppFunctionRequest to refer to this AppFunction.

getPackageName

Added in 1.0.0-alpha01
public final @NonNull String getPackageName()

The package name of the Android app called to execute the app function.

getParameters

Added in 1.0.0-alpha01
public final @NonNull List<@NonNull AppFunctionParameterMetadatagetParameters()

The parameters of the AppFunction.

getResponse

Added in 1.0.0-alpha01
public final @NonNull AppFunctionResponseMetadata getResponse()

The response of the AppFunction.

getSchema

Added in 1.0.0-alpha01
public final AppFunctionSchemaMetadata getSchema()

The predefined schema of the AppFunction. If null, it indicates this function is not implement a particular predefined schema.

hashCode

public int hashCode()

isEnabled

Added in 1.0.0-alpha01
public final boolean isEnabled()

Indicates whether the function is enabled currently or not.

toString

public @NonNull String toString()