Added in API level 36

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, returned by AppFunctionManager.executeAppFunction.

Use AppFunctionMetadata to determine the expected structure of the response.

Summary

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

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)` Constructs an `ExecuteAppFunctionResponse`.
`ExecuteAppFunctionResponse(GenericDocument resultDocument, Bundle extras)` Constructs an `ExecuteAppFunctionResponse` with an additional `Bundle`.
`ExecuteAppFunctionResponse(GenericDocument resultDocument, Bundle extras, List<AppFunctionUriGrant> uriGrants)` Constructs an `ExecuteAppFunctionResponse` with an additional `Bundle` and `AppFunctionUriGrant`s.

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 `GenericDocument` containing the return value of the executed function.
`List<AppFunctionUriGrant>`	`getUriGrants()` The list of `AppFunctionUriGrant` to which the caller of this app function execution should have temporary access granted.
`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 API level 36

public static final String PROPERTY_RETURN_VALUE

The name of the property that stores the function return value within the getResultDocument().

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

Constant Value: "androidAppfunctionsReturnValue"

Fields

CREATOR

Added in API level 36

public static final Creator<ExecuteAppFunctionResponse> CREATOR

Public constructors

ExecuteAppFunctionResponse

Added in API level 36

public ExecuteAppFunctionResponse (GenericDocument resultDocument)

Constructs an ExecuteAppFunctionResponse.

Parameters
`resultDocument`	`GenericDocument`: The return value of the executed function, see `getResultDocument()`. This value cannot be `null`.

ExecuteAppFunctionResponse

Added in API level 36

public ExecuteAppFunctionResponse (GenericDocument resultDocument, 
                Bundle extras)

Constructs an ExecuteAppFunctionResponse with an additional Bundle.

Parameters
`resultDocument`	`GenericDocument`: The return value of the executed function, see `getResultDocument()`. This value cannot be `null`.
`extras`	`Bundle`: The additional metadata for this function execution response, see `getExtras()`. This value cannot be `null`.

ExecuteAppFunctionResponse

Added in API level 37

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

Constructs an ExecuteAppFunctionResponse with an additional Bundle and AppFunctionUriGrants.

Parameters
`resultDocument`	`GenericDocument`: The return value of the executed function, see `getResultDocument()`. This value cannot be `null`.
`extras`	`Bundle`: The additional metadata for this function execution response, see `getExtras()`. This value cannot be `null`.
`uriGrants`	`List`: The list of `AppFunctionUriGrant` to which the caller of this app function execution should have temporary access granted. This value cannot be `null`.

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`

getExtras

Added in API level 36

public Bundle getExtras ()

Returns the additional metadata for this function execution response.

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

getResultDocument

Added in API level 36

public GenericDocument getResultDocument ()

Returns a GenericDocument containing the return value of the executed function.

The 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 AppFunctionMetadata to determine the expected structure of this document.

Returns
`GenericDocument`

getUriGrants

Added in API level 37

public List<AppFunctionUriGrant> getUriGrants ()

The list of AppFunctionUriGrant to which the caller of this app function execution should have temporary access granted.

Returns
`List<AppFunctionUriGrant>`	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`