ExecuteAppFunctionRequest

Artifact: androidx.appfunctions:appfunctions

View Source

Added in 1.0.0-alpha09

---

Kotlin |Java

public final class ExecuteAppFunctionRequest

---

Represents a request to execute a specific app function.

Summary

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

Public methods
final ERROR CLASS: Symbol not found for AppInteractionAttribution?	@RequiresApi(value = 37) getAttribution() The attribution that can be used by the privacy setting to provide transparency to the user about why an app function was invoked.
final @NonNull String	getFunctionIdentifier() The unique string identifier of the app function to be executed.
final @NonNull AppFunctionData	getFunctionParameters() The parameters required to invoke this function.
final @NonNull String	getTargetPackageName() The package name of the app that hosts the function.
static final @NonNull ExecuteAppFunctionRequest	@RequiresApi(value = 36) toCompatExecuteAppFunctionRequest(     @NonNull ExecuteAppFunctionRequest receiver,     @NonNull AppFunctionMetadata functionMetadata ) Creates a androidx.appfunctions.ExecuteAppFunctionRequest from android.app.appfunctions.ExecuteAppFunctionRequest.
final @NonNull ExecuteAppFunctionRequest	@RequiresApi(value = 36) toPlatformExecuteAppFunctionRequest() Converts androidx.appfunctions.ExecuteAppFunctionRequest to android.app.appfunctions.ExecuteAppFunctionRequest.
@NonNull String	toString()

Public constructors

ExecuteAppFunctionRequest

Added in 1.0.0-alpha09

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 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)
public ExecuteAppFunctionRequest(
    @NonNull String targetPackageName,
    @NonNull String functionIdentifier,
    @NonNull AppFunctionData functionParameters,
    @NonNull ERROR CLASS: Symbol not found for 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 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.
@NonNull 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.

Public methods

getAttribution

Added in 1.0.0-alpha09

@RequiresApi(value = 37)
public final ERROR CLASS: Symbol not found for 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

Added in 1.0.0-alpha09

public final @NonNull String getFunctionIdentifier()

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

getFunctionParameters

Added in 1.0.0-alpha09

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

Added in 1.0.0-alpha09

public final @NonNull String getTargetPackageName()

The package name of the app that hosts the function.

toCompatExecuteAppFunctionRequest

Added in 1.0.0-alpha09

@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 AppFunctionMetadata of the function to be executed.

Returns
@NonNull ExecuteAppFunctionRequest	The created androidx.appfunctions.ExecuteAppFunctionRequest.

toPlatformExecuteAppFunctionRequest

Added in 1.0.0-alpha09

@RequiresApi(value = 36)
public final @NonNull ExecuteAppFunctionRequest toPlatformExecuteAppFunctionRequest()

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

Returns
@NonNull ExecuteAppFunctionRequest	The converted android.app.appfunctions.ExecuteAppFunctionRequest.

toString

public @NonNull String toString()