Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#constants) \| [Inherited Constants](https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#inhconstants) \| [Fields](https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#lfields) \| [Ctors](https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#pubctors) \| [Methods](https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#inhmethods)

# ExecuteAppFunctionResponse

*** ** * ** ***


`
public

final

class
ExecuteAppFunctionResponse
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.app.appfunctions.ExecuteAppFunctionResponse |

<br />

*** ** * ** ***

The response to an app function execution, returned by `https://developer.android.com/reference/android/app/appfunctions/AppFunctionManager#executeAppFunction(android.app.AppInteractionSession,%20android.app.appfunctions.ExecuteAppFunctionRequest,%20java.util.concurrent.Executor,%20android.os.CancellationSignal,%20android.os.OutcomeReceiver<android.app.appfunctions.ExecuteAppFunctionResponse,android.app.appfunctions.AppFunctionException>)`.

Use `https://developer.android.com/reference/android/app/appfunctions/AppFunctionMetadata` to determine the expected structure of the response.

## Summary

| ### Constants ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#PROPERTY_RETURN_VALUE` The name of the property that stores the function return value within the `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#getResultDocument()`. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that
the Parcelable object's flattened representation includes a file descriptor.


`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse>` | `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#CREATOR` |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#ExecuteAppFunctionResponse(android.app.appsearch.GenericDocument)(https://developer.android.com/reference/android/app/appsearch/GenericDocument resultDocument) ` Constructs an `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse`. |
| ` https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#ExecuteAppFunctionResponse(android.app.appsearch.GenericDocument,%20android.os.Bundle)(https://developer.android.com/reference/android/app/appsearch/GenericDocument resultDocument, https://developer.android.com/reference/android/os/Bundle extras) ` Constructs an `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse` with an additional `https://developer.android.com/reference/android/os/Bundle`. |
| ` https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#ExecuteAppFunctionResponse(android.app.appsearch.GenericDocument,%20android.os.Bundle,%20java.util.List<android.app.appfunctions.AppFunctionUriGrant>)(https://developer.android.com/reference/android/app/appsearch/GenericDocument resultDocument, https://developer.android.com/reference/android/os/Bundle extras, https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/app/appfunctions/AppFunctionUriGrant> uriGrants) ` Constructs an `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse` with an additional `https://developer.android.com/reference/android/os/Bundle` and `https://developer.android.com/reference/android/app/appfunctions/AppFunctionUriGrant`s. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/android/os/Bundle` | ` https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#getExtras()() ` Returns the additional metadata for this function execution response. |
| ` https://developer.android.com/reference/android/app/appsearch/GenericDocument` | ` https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#getResultDocument()() ` Returns a `https://developer.android.com/reference/android/app/appsearch/GenericDocument` containing the return value of the executed function. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/app/appfunctions/AppFunctionUriGrant>` | ` https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#getUriGrants()() ` The list of `https://developer.android.com/reference/android/app/appfunctions/AppFunctionUriGrant` to which the caller of this app function execution should have temporary access granted. |
| ` void` | ` https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class `

https://developer.android.com/reference/java/lang/Object

` `


https://developer.android.com/reference/java/lang/Object` `
https://developer.android.com/reference/java/lang/Object#clone()()
`

Creates and returns a copy of this object.


`


boolean` `
https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj)
`

Indicates whether some other object is "equal to" this one.


`


void` `
https://developer.android.com/reference/java/lang/Object#finalize()()
`

Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.


`


final

https://developer.android.com/reference/java/lang/Class<?>` `
https://developer.android.com/reference/java/lang/Object#getClass()()
`

Returns the runtime class of this `Object`.


`


int` `
https://developer.android.com/reference/java/lang/Object#hashCode()()
`

Returns a hash code value for the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notify()()
`

Wakes up a single thread that is waiting on this object's
monitor.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notifyAll()()
`

Wakes up all threads that are waiting on this object's monitor.


`


https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Object#toString()()
`

Returns a string representation of the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` `
https://developer.android.com/reference/java/lang/Object#wait(long)(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` `
https://developer.android.com/reference/java/lang/Object#wait()()
`

Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*.


From interface `

https://developer.android.com/reference/android/os/Parcelable

` `
abstract


int` `
https://developer.android.com/reference/android/os/Parcelable#describeContents()()
`

Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation.


`
abstract


void` `
https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags)
`

Flatten this object in to a Parcel.


## Constants

### PROPERTY_RETURN_VALUE

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String PROPERTY_RETURN_VALUE
```

The name of the property that stores the function return value within the `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#getResultDocument()`.

If the function returns `void` or throws an error, this property will not be set.

<br />

Constant Value:

"androidAppfunctionsReturnValue"


## Fields

### CREATOR

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<ExecuteAppFunctionResponse> CREATOR
```

<br />

<br />

## Public constructors

### ExecuteAppFunctionResponse

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ExecuteAppFunctionResponse (GenericDocument resultDocument)
```

Constructs an `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse`.

<br />

| Parameters ||
|---|---|
| `resultDocument` | `GenericDocument`: The return value of the executed function, see `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#getResultDocument()`. This value cannot be `null`. <br /> |

### ExecuteAppFunctionResponse

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ExecuteAppFunctionResponse (GenericDocument resultDocument, 
                Bundle extras)
```

Constructs an `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse` with an additional `https://developer.android.com/reference/android/os/Bundle`.

<br />

| Parameters ||
|---|---|
| `resultDocument` | `GenericDocument`: The return value of the executed function, see `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#getResultDocument()`. This value cannot be `null`. <br /> |
| `extras` | `Bundle`: The additional metadata for this function execution response, see `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#getExtras()`. This value cannot be `null`. <br /> |

### ExecuteAppFunctionResponse

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ExecuteAppFunctionResponse (GenericDocument resultDocument, 
                Bundle extras, 
                List<AppFunctionUriGrant> uriGrants)
```

Constructs an `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse` with an additional `https://developer.android.com/reference/android/os/Bundle` and `https://developer.android.com/reference/android/app/appfunctions/AppFunctionUriGrant`s.

<br />

| Parameters ||
|---|---|
| `resultDocument` | `GenericDocument`: The return value of the executed function, see `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#getResultDocument()`. This value cannot be `null`. <br /> |
| `extras` | `Bundle`: The additional metadata for this function execution response, see `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#getExtras()`. This value cannot be `null`. <br /> |
| `uriGrants` | `List`: The list of `https://developer.android.com/reference/android/app/appfunctions/AppFunctionUriGrant` to which the caller of this app function execution should have temporary access granted. This value cannot be `null`. <br /> |

## Public methods

### describeContents

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getExtras

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Bundle getExtras ()
```

Returns the additional metadata for this function execution response.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/Bundle` | This value cannot be `null`. <br /> |

### getResultDocument

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public GenericDocument getResultDocument ()
```

Returns a `https://developer.android.com/reference/android/app/appsearch/GenericDocument` containing the return value of the executed function.

The `https://developer.android.com/reference/android/app/appfunctions/ExecuteAppFunctionResponse#PROPERTY_RETURN_VALUE` key can be used to obtain the return value.

Example of extracting the return value:

    GenericDocument resultDocument = response.getResultDocument();
    Object returnValue = resultDocument.getProperty(PROPERTY_RETURN_VALUE);
    if (returnValue != null) {
      // Cast returnValue to expected type, or use GenericDocument#getPropertyString,
      // GenericDocument#getPropertyLong, etc.
    }

Use `https://developer.android.com/reference/android/app/appfunctions/AppFunctionMetadata` to determine the expected structure of this document.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/app/appsearch/GenericDocument` | <br /> |

### getUriGrants

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<AppFunctionUriGrant> getUriGrants ()
```

The list of `https://developer.android.com/reference/android/app/appfunctions/AppFunctionUriGrant` to which the caller of this app function execution
should have temporary access granted.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/app/appfunctions/AppFunctionUriGrant>` | This value cannot be `null`. <br /> |

### writeToParcel

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |