ExecuteAppFunctionRequest


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
)

Public methods

final @NonNull String

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

final @NonNull AppFunctionData

The parameters required to invoke this function.

final @NonNull String

The package name of the app that hosts the function.

static final @NonNull ExecuteAppFunctionRequest

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

final @NonNull ExecuteAppFunctionRequest

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

@NonNull String

Public constructors

ExecuteAppFunctionRequest

Added in 1.0.0-alpha08
public ExecuteAppFunctionRequest(
    @NonNull String targetPackageName,
    @NonNull String functionIdentifier,
    @NonNull AppFunctionData functionParameters
)

Public methods

getFunctionIdentifier

Added in 1.0.0-alpha08
public final @NonNull String getFunctionIdentifier()

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

getFunctionParameters

Added in 1.0.0-alpha08
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-alpha08
public final @NonNull String getTargetPackageName()

The package name of the app that hosts the function.

toCompatExecuteAppFunctionRequest

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

toString

public @NonNull String toString()