Added in API level 36

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

ExecuteAppFunctionRequest

Kotlin |Java

public final class ExecuteAppFunctionRequest
extends Object implements Parcelable

java.lang.Object
↳	android.app.appfunctions.ExecuteAppFunctionRequest

A request to execute an app function, provided to AppFunctionManager.executeAppFunction.

Use AppFunctionMetadata to construct a ExecuteAppFunctionRequest that correctly targets an app function.

Summary

Nested classes
`class`	`ExecuteAppFunctionRequest.Builder` Builder for `ExecuteAppFunctionRequest`.

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<ExecuteAppFunctionRequest>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`AppFunctionActivityId`	`getActivityId()` Returns the `AppFunctionActivityId` for this request.
`AppInteractionAttribution`	`getAttribution()` Returns the `AppInteractionAttribution` for the `ExecuteAppFunctionRequest`.
`Bundle`	`getExtras()` Returns the additional values for this function execution request.
`String`	`getFunctionIdentifier()` Returns the unique identifier of the app function to be executed.
`GenericDocument`	`getParameters()` Returns the function parameters as a key-value `GenericDocument`.
`String`	`getTargetPackageName()` Returns the package name of the app that hosts the app function.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 36

public static final Creator<ExecuteAppFunctionRequest> CREATOR

Public methods

describeContents

Added in API level 36

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getActivityId

Added in API level 37

public AppFunctionActivityId getActivityId ()

Returns the AppFunctionActivityId for this request.

This identifier is used to disambiguate between instances of the same app function running in different activities when the function's AppFunctionMetadata.getScope is AppFunctionMetadata.SCOPE_ACTIVITY.

If this returns null, the request targets an app function that is not AppFunctionMetadata.SCOPE_ACTIVITY.

Returns
`AppFunctionActivityId`

getAttribution

Added in API level 37

public AppInteractionAttribution getAttribution ()

Returns the AppInteractionAttribution for the ExecuteAppFunctionRequest.

This information can be used by the privacy setting to provide transparency to the user about why an app function was invoked.

Returns
`AppInteractionAttribution`	This value may be `null`.

getExtras

Added in API level 36

public Bundle getExtras ()

Returns the additional values for this function execution request.

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

getFunctionIdentifier

Added in API level 36

public String getFunctionIdentifier ()

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

See AppFunctionMetadata.getName for how to determine this value.

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

getParameters

Added in API level 36

public GenericDocument getParameters ()

Returns the function parameters as a key-value GenericDocument.

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

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

getTargetPackageName

Added in API level 36

public String getTargetPackageName ()

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

See AppFunctionMetadata.getName for how to determine this value.

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

writeToParcel

Added in API level 36

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`

ExecuteAppFunctionRequest

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

getActivityId

getAttribution

getExtras

getFunctionIdentifier

getParameters

getTargetPackageName

writeToParcel