ExecuteAppFunctionRequest
public final class ExecuteAppFunctionRequest
Represents a request to execute a specific app function.
Summary
Public constructors |
|---|
ExecuteAppFunctionRequest(Creates a new |
@RequiresApi(value = 37)Creates a new |
Public constructors
ExecuteAppFunctionRequest
public ExecuteAppFunctionRequest(
@NonNull String targetPackageName,
@NonNull String functionIdentifier,
@NonNull AppFunctionData functionParameters
)
Creates a new ExecuteAppFunctionRequest.
| Parameters | |
|---|---|
@NonNull String targetPackageName |
The package name of the app that hosts the function. |
@NonNull String functionIdentifier |
The unique string identifier of the app function to be executed. |
@NonNull AppFunctionData functionParameters |
The parameters required to invoke this function. Within this |
ExecuteAppFunctionRequest
@RequiresApi(value = 37)
public ExecuteAppFunctionRequest(
@NonNull String targetPackageName,
@NonNull String functionIdentifier,
@NonNull AppFunctionData functionParameters,
@NonNull AppInteractionAttribution attribution
)
Creates a new ExecuteAppFunctionRequest with attribution.
| Parameters | |
|---|---|
@NonNull String targetPackageName |
The package name of the app that hosts the function. |
@NonNull String functionIdentifier |
The unique string identifier of the app function to be executed. |
@NonNull AppFunctionData functionParameters |
The parameters required to invoke this function. Within this |
@NonNull AppInteractionAttribution attribution |
The attribution that can be used by the privacy setting to provide transparency to the user about why an app function was invoked. |
Public methods
getAttribution
@RequiresApi(value = 37)
public final AppInteractionAttribution getAttribution()
The attribution that can be used by the privacy setting to provide transparency to the user about why an app function was invoked.
getFunctionIdentifier
public final @NonNull String getFunctionIdentifier()
The unique string identifier of the app function to be executed.
getFunctionParameters
public final @NonNull AppFunctionData getFunctionParameters()
The parameters required to invoke this function. Within this AppFunctionData, the property names are the names of the function parameters and the property values are the values of those parameters. The data object may have missing parameters. Developers are advised to implement defensive handling measures.
getTargetPackageName
public final @NonNull String getTargetPackageName()
The package name of the app that hosts the function.
toCompatExecuteAppFunctionRequest
@RequiresApi(value = 36)
public static final @NonNull ExecuteAppFunctionRequest toCompatExecuteAppFunctionRequest(
@NonNull ExecuteAppFunctionRequest receiver,
@NonNull AppFunctionMetadata functionMetadata
)
Creates a androidx.appfunctions.ExecuteAppFunctionRequest from android.app.appfunctions.ExecuteAppFunctionRequest.
The provided AppFunctionMetadata is used to validate the created androidx.appfunctions.ExecuteAppFunctionRequest.
| Parameters | |
|---|---|
@NonNull AppFunctionMetadata functionMetadata |
the |
| Returns | |
|---|---|
@NonNull ExecuteAppFunctionRequest |
The created |
toPlatformExecuteAppFunctionRequest
@RequiresApi(value = 36)
public final @NonNull ExecuteAppFunctionRequest toPlatformExecuteAppFunctionRequest()
Converts androidx.appfunctions.ExecuteAppFunctionRequest to android.app.appfunctions.ExecuteAppFunctionRequest.
| Returns | |
|---|---|
@NonNull ExecuteAppFunctionRequest |
The converted |