ExecuteAppFunctionResponse
public
final
class
ExecuteAppFunctionResponse
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.app.appfunctions.ExecuteAppFunctionResponse |
The response to an app function execution.
Summary
Constants | |
---|---|
String |
PROPERTY_RETURN_VALUE
The name of the property that stores the function return value within the |
Inherited constants |
---|
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 | |
---|---|
Constants
PROPERTY_RETURN_VALUE
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
Public constructors
ExecuteAppFunctionResponse
public ExecuteAppFunctionResponse (GenericDocument resultDocument)
Parameters | |
---|---|
resultDocument |
GenericDocument : The return value of the executed function.
This value cannot be null . |
ExecuteAppFunctionResponse
public ExecuteAppFunctionResponse (GenericDocument resultDocument, Bundle extras)
Parameters | |
---|---|
resultDocument |
GenericDocument : The return value of the executed function.
This value cannot be null . |
extras |
Bundle : The additional metadata for this function execution response.
This value cannot be null . |
Public methods
describeContents
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(android.os.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
public Bundle getExtras ()
Returns the additional metadata for this function execution response.
Returns | |
---|---|
Bundle |
This value cannot be null . |
getResultDocument
public GenericDocument getResultDocument ()
Returns a generic document containing the return value of the executed function.
The PROPERTY_RETURN_VALUE
key can be used to obtain the return value.
Sample code for extracting the return value:
GenericDocument resultDocument = response.getResultDocument(); Object returnValue = resultDocument.getProperty(PROPERTY_RETURN_VALUE); if (returnValue != null) { // Cast returnValue to expected type, or useGenericDocument.getPropertyString
, //GenericDocument.getPropertyLong
etc. // Do something with the returnValue }
Returns | |
---|---|
GenericDocument |
writeToParcel
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 Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |