ExecuteAppFunctionRequest

class ExecuteAppFunctionRequest

Represents a request to execute a specific app function.

Summary

Public companion functions
ExecuteAppFunctionRequest

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: AppInteractionAttribution,
    activityId: AppFunctionActivityId?
)

Creates a new ExecuteAppFunctionRequest with attribution.

Public functions
ExecuteAppFunctionRequest

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

Public properties
AppFunctionActivityId?

The AppFunctionActivityId for this request.
AppInteractionAttribution?

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

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

The parameters required to invoke this function.
String

The package name of the app that hosts the function.

Public companion functions

ExecuteAppFunctionRequest.toCompatExecuteAppFunctionRequest

@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-alpha12
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

Added in 1.0.0-alpha12
@RequiresApi(value = 37)
ExecuteAppFunctionRequest(
    targetPackageName: String,
    functionIdentifier: String,
    functionParameters: AppFunctionData,
    attribution: AppInteractionAttribution,
    activityId: AppFunctionActivityId? = null
)

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: AppInteractionAttribution

The attribution that can be used by the privacy setting to provide transparency to the user about why an app function was invoked.
activityId: AppFunctionActivityId? = null

The AppFunctionActivityId for this request. This identifier is used to disambiguate between instances of the same app function running in different activities when the function's AppFunctionMetadata.scope is AppFunctionMetadata.SCOPE_ACTIVITY. If the property's value is null, the request targets an app function that is not AppFunctionMetadata.SCOPE_ACTIVITY.

Public functions

toPlatformExecuteAppFunctionRequest

Added in 1.0.0-alpha12
@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

activityId

Added in 1.0.0-alpha12
val activityId: AppFunctionActivityId?

The AppFunctionActivityId for this request.

This identifier is used to disambiguate between instances of the same app function running in different activities when the function's AppFunctionMetadata.scope is AppFunctionMetadata.SCOPE_ACTIVITY.

If the property's value is null, the request targets an app function that is not AppFunctionMetadata.SCOPE_ACTIVITY.

attribution

Added in 1.0.0-alpha12
val attribution: 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-alpha12
val functionIdentifier: String

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

functionParameters

Added in 1.0.0-alpha12
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-alpha12
val targetPackageName: String

The package name of the app that hosts the function.