A builder for ActionResponse objects.
Methods
| Method | Return type | Brief description |
|---|---|---|
build() | ActionResponse | Builds the current action response and validates it. |
setNavigation(navigation) | ActionResponseBuilder | Sets the response to a Navigation action. |
setNotification(notification) | ActionResponseBuilder | Sets the notification to display when the action is activated. |
setOpenLink(openLink) | ActionResponseBuilder | Sets the URL to navigate to when the action is activated. |
setStateChanged(stateChanged) | ActionResponseBuilder | Sets a flag to indicate that this action changed the existing data state. |
Detailed documentation
build()
Builds the current action response and validates it.
Return
ActionResponse — A validated ActionResponse.
Throws
Error — if the constructed action response isn't valid.
setNotification(notification)
Sets the notification to display when the action is activated.
Parameters
| Name | Type | Description |
|---|---|---|
notification | Notification | The Notification to use. |
Return
ActionResponseBuilder — This object, for chaining.
setOpenLink(openLink)
Sets the URL to navigate to when the action is activated.
Parameters
| Name | Type | Description |
|---|---|---|
openLink | OpenLink | The OpenLink to use. |
Return
ActionResponseBuilder — This object, for chaining.
setStateChanged(stateChanged)
Sets a flag to indicate that this action changed the existing data state. For example, if the action created a task or updated contact information. When this flag is set to true, services such as Gmail can attempt to clear any cached state data associated with this action.
Parameters
| Name | Type | Description |
|---|---|---|
stateChanged | Boolean | Whether this action has changed the existing state data. Defaults to false. |
Return
ActionResponseBuilder — This object, for chaining.