ExecuteAppFunctionRequest

Kotlin |Java

class ExecuteAppFunctionRequest : Parcelable

kotlin.Any
↳	android.app.appsearch.functions.ExecuteAppFunctionRequest

Represents a request to execute a specific app function.

Summary

Nested classes
	`Builder` The builder for creating `ExecuteAppFunctionRequest` instances.

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
Bundle	`getExtras()` Returns additional metadata relevant to this function execution request.
String	`getFunctionIdentifier()` Returns the unique string identifier of the app function to be executed.
GenericDocument	`getParameters()` Returns the parameters required to invoke this function.
ByteArray?	`getSha256Certificate()` Returns the expected certificate SHA-256 digests of the target package.
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

getExtras

Added in API level Baklava

fun getExtras(): Bundle

Returns additional metadata relevant to 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.

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

getParameters

Added in API level Baklava

fun getParameters(): GenericDocument

Returns the parameters required to invoke this function. Within this GenericDocument, the property names are the names of the function parameters and the property values are the values of those parameters

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

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

getSha256Certificate

Added in API level Baklava

fun getSha256Certificate(): ByteArray?

Returns the expected certificate SHA-256 digests of the target package. Returns null if no certificate digest checking is configured.

See Also

android.app.appsearch.functions.ExecuteAppFunctionRequest.Builder#getSha256Certificate()

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!>