ExecuteAppFunctionRequest
class ExecuteAppFunctionRequest : Parcelable
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
|
Builder for |
|
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| AppFunctionActivityId? |
Returns the |
| AppInteractionAttribution? |
Returns the |
| Bundle |
Returns the additional values for this function execution request. |
| String |
Returns the unique identifier of the app function to be executed. |
| GenericDocument |
Returns the function parameters as a key-value |
| String |
Returns the package name of the app that hosts the app function. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<ExecuteAppFunctionRequest!> | |
Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
getActivityId
fun getActivityId(): AppFunctionActivityId?
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.
getAttribution
fun getAttribution(): AppInteractionAttribution?
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.
| Return | |
|---|---|
AppInteractionAttribution? |
This value may be null. |
getExtras
fun getExtras(): Bundle
Returns the additional values for this function execution request.
| Return | |
|---|---|
Bundle |
This value cannot be null. |
getFunctionIdentifier
fun getFunctionIdentifier(): String
Returns the unique identifier of the app function to be executed.
See AppFunctionMetadata.getName for how to determine this value.
| Return | |
|---|---|
String |
This value cannot be null. |
getParameters
fun getParameters(): GenericDocument
Returns the function parameters as a key-value GenericDocument.
The GenericDocument may have missing parameters. Developers are advised to implement defensive handling measures.
| Return | |
|---|---|
GenericDocument |
This value cannot be null. |
getTargetPackageName
fun getTargetPackageName(): String
Returns the package name of the app that hosts the app function.
See AppFunctionMetadata.getName for how to determine this value.
| Return | |
|---|---|
String |
This value cannot be null. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|