Summary: Ctors | Methods | Inherited Methods

ExecuteAppFunctionRequest.Builder

Kotlin |Java

public static final class ExecuteAppFunctionRequest.Builder
extends Object

java.lang.Object
↳	android.app.appsearch.functions.ExecuteAppFunctionRequest.Builder

The builder for creating ExecuteAppFunctionRequest instances.

Summary

Public constructors
`Builder(String packageName, String functionIdentifier)` Creates a new instance of this builder class.

Public methods
`ExecuteAppFunctionRequest`	`build()` Constructs a new `ExecuteAppFunctionRequest` from the contents of this builder.
`ExecuteAppFunctionRequest.Builder`	`setExtras(Bundle extras)` Sets the additional metadata relevant to this function execution request.
`ExecuteAppFunctionRequest.Builder`	`setParameters(GenericDocument parameters)` Sets parameters for invoking the app function.
`ExecuteAppFunctionRequest.Builder`	`setSha256Certificate(byte[] sha256Certificate)` Sets the expected certificate SHA-256 digests for the target package.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in Android Baklava

public Builder (String packageName, 
                String functionIdentifier)

Creates a new instance of this builder class.

Parameters
`packageName`	`String`: The package name of the target app providing the app function to invoke. This value cannot be `null`.
`functionIdentifier`	`String`: The identifier used by the `AppFunctionService` from the target app to uniquely identify the function to be invoked. This value cannot be `null`.

Public methods

build

Added in Android Baklava

public ExecuteAppFunctionRequest build ()

Constructs a new ExecuteAppFunctionRequest from the contents of this builder.

Returns
`ExecuteAppFunctionRequest`	This value cannot be `null`.

setExtras

Added in Android Baklava

public ExecuteAppFunctionRequest.Builder setExtras (Bundle extras)

Sets the additional metadata relevant to this function execution request. Defaults to an empty Bundle if not set.

Parameters
`extras`	`Bundle`: This value cannot be `null`.

Returns
`ExecuteAppFunctionRequest.Builder`	This value cannot be `null`.

setParameters

Added in Android Baklava

public ExecuteAppFunctionRequest.Builder setParameters (GenericDocument parameters)

Sets parameters for invoking the app function. Within this GenericDocument, the property names are the names of the function parameters and the property values are the values of those parameters. Defaults to an empty GenericDocument if not set.

Parameters
`parameters`	`GenericDocument`: This value cannot be `null`.

Returns
`ExecuteAppFunctionRequest.Builder`	This value cannot be `null`.

setSha256Certificate

Added in Android Baklava

public ExecuteAppFunctionRequest.Builder setSha256Certificate (byte[] sha256Certificate)

Sets the expected certificate SHA-256 digests for the target package. Setting this to null indicates that no certificate digest check will be performed.

SHA-256 certificate digests for a signed application can be retrieved with the apksigner tool that is part of the Android SDK build tools. Use apksigner verify --print-certs path/to/apk.apk to retrieve the SHA-256 certificate digest for the target application. Once retrieved, the SHA-256 certificate digest should be converted to a byte[] by decoding it in base16:

 new android.content.pm.Signature(outputDigest).toByteArray();

Parameters
`sha256Certificate`	`byte`: This value may be `null`.

Returns
`ExecuteAppFunctionRequest.Builder`