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
schemais not null, the caller can look up the input/output information based on the schema definition, and call the function accordingly. -
Examine
parametersandresponse: 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( |
Public methods |
|
|---|---|
boolean |
|
final @NonNull AppFunctionComponentsMetadata |
Reusable components that could be shared within the function specification. |
final AppFunctionDeprecationMetadata |
Deprecation details about the function, if the AppFunction is deprecated. |
final @NonNull String |
A description of the AppFunction and its intended use. |
final @NonNull String |
getId()The ID used in an |
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 |
hashCode() |
final boolean |
Indicates whether the function is enabled currently or not. |
@NonNull String |
toString() |
Public constructors
AppFunctionMetadata
public AppFunctionMetadata(
@NonNull String id,
@NonNull String packageName,
boolean isEnabled,
AppFunctionSchemaMetadata schema,
@NonNull List<@NonNull AppFunctionParameterMetadata> parameters,
@NonNull AppFunctionResponseMetadata response,
@NonNull AppFunctionComponentsMetadata components,
@NonNull String description,
AppFunctionDeprecationMetadata deprecation
)
Public methods
getComponents
public final @NonNull AppFunctionComponentsMetadata getComponents()
Reusable components that could be shared within the function specification.
getDeprecation
public final AppFunctionDeprecationMetadata getDeprecation()
Deprecation details about the function, if the AppFunction is deprecated. This will be null if the function is not deprecated.
getDescription
public final @NonNull String getDescription()
A description of the AppFunction and its intended use.
getId
public final @NonNull String getId()
The ID used in an androidx.appfunctions.ExecuteAppFunctionRequest to refer to this AppFunction.
getPackageName
public final @NonNull String getPackageName()
The package name of the Android app called to execute the app function.
getParameters
public final @NonNull List<@NonNull AppFunctionParameterMetadata> getParameters()
The parameters of the AppFunction.
getResponse
public final @NonNull AppFunctionResponseMetadata getResponse()
The response of the AppFunction.
getSchema
public final AppFunctionSchemaMetadata getSchema()
The predefined schema of the AppFunction. If null, it indicates this function is not implement a particular predefined schema.
isEnabled
public final boolean isEnabled()
Indicates whether the function is enabled currently or not.