ExecuteAppFunctionResponse

Kotlin |Java

public final class ExecuteAppFunctionResponse
extends Object implements Parcelable

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

The response to an app function execution.

The ExecuteAppFunctionResponse.getResultDocument() contains the function's return value as a GenericDocument. This can be converted back into a structured class using the AppFunction SDK.

The ExecuteAppFunctionResponse.getExtras() provides any extra metadata returned by the function. The AppFunction SDK can expose structured APIs by packing and unpacking this Bundle.

Summary

Constants
`String`	`PROPERTY_RETURN_VALUE` The name of the property that stores the function return value within the `resultDocument`.

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<ExecuteAppFunctionResponse>`	`CREATOR`

Public constructors
`ExecuteAppFunctionResponse(GenericDocument resultDocument)`
`ExecuteAppFunctionResponse(GenericDocument resultDocument, Bundle extras)`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`Bundle`	`getExtras()` Returns the additional metadata for this function execution response.
`GenericDocument`	`getResultDocument()` Returns a generic document containing the return value of the executed 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.

Constants

PROPERTY_RETURN_VALUE

Added in Android Baklava

public static final String PROPERTY_RETURN_VALUE

The name of the property that stores the function return value within the resultDocument.

See GenericDocument.getProperty(String) for more information.

If the function returns void or throws an error, the resultDocument will be empty GenericDocument.

If the resultDocument is empty, GenericDocument.getProperty(String) will return null.

See getResultDocument() for more information on extracting the return value.

Constant Value: "androidAppfunctionsReturnValue"

Fields

CREATOR

Added in Android Baklava

public static final Creator<ExecuteAppFunctionResponse> CREATOR

Public constructors