ExecuteAppFunctionRequest

Kotlin |Java

class ExecuteAppFunctionRequest : Parcelable

kotlin.Any
↳	android.app.appfunctions.ExecuteAppFunctionRequest

A request to execute an app function.

Summary

Nested classes
	`Builder` Builder for `ExecuteAppFunctionRequest`.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Bundle	`getExtras()` Returns the additional metadata for this function execution request.
String	`getFunctionIdentifier()` Returns the unique string identifier of the app function to be executed.
GenericDocument	`getParameters()` Returns the function parameters.
String	`getTargetPackageName()` Returns the package name of the app that hosts the function.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<ExecuteAppFunctionRequest!>	`CREATOR`

Public methods

describeContents

Added in API level Baklava

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getExtras

Added in API level Baklava

fun getExtras(): Bundle

Returns the additional metadata for this function execution request.

Return
`Bundle`	This value cannot be `null`.

getFunctionIdentifier

Added in API level Baklava

fun getFunctionIdentifier(): String

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

When there is a package change or the device starts up, the metadata of available functions is indexed by AppSearch. AppSearch stores the indexed information as AppFunctionStaticMetadata document.

The ID can be obtained by querying the AppFunctionStaticMetadata documents from AppSearch.

If the functionId provided is invalid, the caller will get an invalid argument response.

Return
`String`	This value cannot be `null`.

getParameters

Added in API level Baklava

fun getParameters(): GenericDocument

Returns the function parameters. The key is the parameter name, and the value is the parameter value.

The GenericDocument may have missing parameters. Developers are advised to implement defensive handling measures.

Return
`GenericDocument`	This value cannot be `null`.

See Also

android.app.appfunctions.AppFunctionManager

getTargetPackageName

Added in API level Baklava

fun getTargetPackageName(): String

Returns the package name of the app that hosts the function.

Return
`String`	This value cannot be `null`.

writeToParcel

Added in API level Baklava

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level Baklava

static val CREATOR: Parcelable.Creator<ExecuteAppFunctionRequest!>