ExecuteAppFunctionRequest

Artifact: androidx.appfunctions:appfunctions

Kotlin |Java

class ExecuteAppFunctionRequest

Represents a request to execute a specific app function.

Summary

Public companion functions
`ExecuteAppFunctionRequest`	`@RequiresApi(value = 36) ExecuteAppFunctionRequest.toCompatExecuteAppFunctionRequest( functionMetadata: AppFunctionMetadata )` Creates a `androidx.appfunctions.ExecuteAppFunctionRequest` from `android.app.appfunctions.ExecuteAppFunctionRequest`.

Public constructors
`ExecuteAppFunctionRequest( targetPackageName: String, functionIdentifier: String, functionParameters: AppFunctionData )` Creates a new `ExecuteAppFunctionRequest`.
`@RequiresApi(value = 37) ExecuteAppFunctionRequest( targetPackageName: String, functionIdentifier: String, functionParameters: AppFunctionData, attribution: ERROR CLASS: Symbol not found for AppInteractionAttribution )` Creates a new `ExecuteAppFunctionRequest` with attribution.

Public functions
`ExecuteAppFunctionRequest`	`@RequiresApi(value = 36) toPlatformExecuteAppFunctionRequest()` Converts `androidx.appfunctions.ExecuteAppFunctionRequest` to `android.app.appfunctions.ExecuteAppFunctionRequest`.
`open String`	`toString()`

Public properties
`ERROR CLASS: Symbol not found for 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.
`String`	`functionIdentifier` The unique string identifier of the app function to be executed.
`AppFunctionData`	`functionParameters` The parameters required to invoke this function.
`String`	`targetPackageName` The package name of the app that hosts the function.

Public companion functions

ExecuteAppFunctionRequest.toCompatExecuteAppFunctionRequest

Artifact: androidx.appfunctions:appfunctions

View Source

Added in 1.0.0-alpha09

@RequiresApi(value = 36)
fun ExecuteAppFunctionRequest.toCompatExecuteAppFunctionRequest(
    functionMetadata: AppFunctionMetadata
): ExecuteAppFunctionRequest

Creates a androidx.appfunctions.ExecuteAppFunctionRequest from android.app.appfunctions.ExecuteAppFunctionRequest.

The provided AppFunctionMetadata is used to validate the created androidx.appfunctions.ExecuteAppFunctionRequest.

Parameters
`functionMetadata: AppFunctionMetadata`	the `AppFunctionMetadata` of the function to be executed.

Returns
`ExecuteAppFunctionRequest`	The created `androidx.appfunctions.ExecuteAppFunctionRequest`.

Public constructors

ExecuteAppFunctionRequest

Added in 1.0.0-alpha09

ExecuteAppFunctionRequest(
    targetPackageName: String,
    functionIdentifier: String,
    functionParameters: AppFunctionData
)

Creates a new ExecuteAppFunctionRequest.

Parameters
`targetPackageName: String`	The package name of the app that hosts the function.
`functionIdentifier: String`	The unique string identifier of the app function to be executed.
`functionParameters: AppFunctionData`	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.

ExecuteAppFunctionRequest

@RequiresApi(value = 37)
ExecuteAppFunctionRequest(
    targetPackageName: String,
    functionIdentifier: String,
    functionParameters: AppFunctionData,
    attribution: ERROR CLASS: Symbol not found for AppInteractionAttribution
)

Creates a new ExecuteAppFunctionRequest with attribution.

Parameters
`targetPackageName: String`	The package name of the app that hosts the function.
`functionIdentifier: String`	The unique string identifier of the app function to be executed.
`functionParameters: AppFunctionData`	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.
`attribution: ERROR CLASS: Symbol not found for AppInteractionAttribution`	The attribution that can be used by the privacy setting to provide transparency to the user about why an app function was invoked.

Public functions

toPlatformExecuteAppFunctionRequest

Added in 1.0.0-alpha09

@RequiresApi(value = 36)
fun toPlatformExecuteAppFunctionRequest(): ExecuteAppFunctionRequest

Converts androidx.appfunctions.ExecuteAppFunctionRequest to android.app.appfunctions.ExecuteAppFunctionRequest.

Returns
`ExecuteAppFunctionRequest`	The converted `android.app.appfunctions.ExecuteAppFunctionRequest`.

toString

open fun toString(): String

Public properties

attribution

Added in 1.0.0-alpha09

val attribution: ERROR CLASS: Symbol not found for AppInteractionAttribution??

The attribution that can be used by the privacy setting to provide transparency to the user about why an app function was invoked.

functionIdentifier

Added in 1.0.0-alpha09

val functionIdentifier: String

The unique string identifier of the app function to be executed.

functionParameters

Added in 1.0.0-alpha09

val functionParameters: AppFunctionData

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.

targetPackageName

Added in 1.0.0-alpha09

val targetPackageName: String

The package name of the app that hosts the function.