A builder for Action
objects.
Available for Google Workspace add-ons.
const notification = AddOnsResponseService . newNotification (). setText ( "You closed a dialog!" ); const navigation = AddOnsResponseService . newNavigation () . setEndNavigation ( AddOnsResponseService . EndNavigation . CLOSE_DIALOG ); const action = AddOnsResponseService . newActionResponseBuilder () . setNavigation ( navigation ) . setNotification ( notification ) . build ();
Methods
| Method | Return type | Brief description |
|---|---|---|
Action
|
Sets the modify card operation to the action. | |
Action
|
Builds the current action response and validates it. | |
Action
|
Sets the LinkPreview to the action. | |
Action
|
Sets the response to a Navigation
action. |
|
Action
|
Sets the notification to display when the action is activated. | |
Action
|
Sets the URL to navigate to when the action is activated. | |
Action
|
Sets a flag to indicate that this action changed the existing data state. |
Detailed documentation
add
Sets the modify card operation to the action.
Parameters
| Name | Type | Description |
|---|---|---|
modify
|
Modify
|
The Modify
to use. |
Return
Action
— This object, for chaining.
build()
Builds the current action response and validates it.
Return
Action
— A validated ActionResponse.
Throws
Error
— if the constructed action response isn't valid.
set
Sets the LinkPreview to the action.
Parameters
| Name | Type | Description |
|---|---|---|
link
|
Link
|
The Link
to use. |
Return
Action
— This object, for chaining.
set
Sets the notification to display when the action is activated.
const notification = AddOnsResponseService . newNotification (). setText ( "You closed a dialog!" ); const action = AddOnsResponseService . newActionResponseBuilder () . setNotification ( notification ) . build ();
Parameters
| Name | Type | Description |
|---|---|---|
notification
|
Notification
|
The Notification
to use. |
Return
Action
— This object, for chaining.
set
Sets the URL to navigate to when the action is activated.
Parameters
| Name | Type | Description |
|---|---|---|
open
|
Open
|
The Open
to use. |
Return
Action
— This object, for chaining.
set
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 |
|---|---|---|
state
|
Boolean
|
Whether this action has changed the existing state data. Defaults to false
. |
Return
Action
— This object, for chaining.
