Class ChatActionResponse
Page Summary
ChatActionResponse is a class used by Google Chat apps to configure how their responses are posted.
This class is exclusively available for Google Chat apps and not for Google Workspace add-ons.
Key methods include setting a dialog action, the response type, an updated widget for autocomplete, or a URL for authentication or configuration.
Each method returns the ChatActionResponse object for method chaining.
A class that represents the parameters that a Chat app can use to configure how its response isposted.
Only available for Google Chat apps. Not available for Google Workspace add-ons.
constcard=CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('Card title')).build();constdialog=CardService.newDialog().setBody(card);constdialogAction=CardService.newDialogAction().setDialog(dialog);constchatActionResponse=CardService.newChatActionResponse().setResponseType(CardService.Type.DIALOG).setDialogAction(dialogAction);
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Chat | Sets the dialog action to an event related to a dialog. |
set | Chat | The type of Chat app response. |
set | Chat | Sets the updated widget, used to provide autocomplete options for a widget. |
set | Chat | The URL for users to authenticate or configure. |
Detailed documentation
setDialogAction(dialogAction)
Sets the dialog action to an event related to a dialog.
constcard=CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('Card title')).build();constdialog=CardService.newDialog().setBody(card);constdialogAction=CardService.newDialogAction().setDialog(dialog);constchatActionResponse=CardService.newChatActionResponse().setResponseType(CardService.Type.DIALOG).setDialogAction(dialogAction);
Parameters
| Name | Type | Description |
|---|---|---|
dialog | Dialog | The dialog action to set. |
Return
Chat — This object, for chaining.
setResponseType(responseType)
The type of Chat app response.
constchatActionResponse=CardService.newChatActionResponse().setResponseType(CardService.Type.DIALOG,);
Parameters
| Name | Type | Description |
|---|---|---|
response | Response | The response type. |
Return
Chat — This object, for chaining.
setUpdatedWidget(updatedWidget)
Sets the updated widget, used to provide autocomplete options for a widget.
constupdatedWidget=CardService.newUpdatedWidget().addItem('Contact 1','contact-1',false,'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png','Contact one description',).addItem('Contact 2','contact-2',false,'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png','Contact two description',).addItem('Contact 3','contact-3',false,'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png','Contact three description',).addItem('Contact 4','contact-4',false,'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png','Contact four description',).addItem('Contact 5','contact-5',false,'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png','Contact five description',);constactionResponse=CardService.newChatActionResponse().setUpdatedWidget(updatedWidget).setResponseType(CardService.ResponseType.UPDATE_WIDGET);
Parameters
| Name | Type | Description |
|---|---|---|
updated | Updated | The updated widget to be set. |
Return
Chat — This object, for chaining.
setUrl(url)
The URL for users to authenticate or configure. Only for theREQUEST_CONFIG responsetype.
constchatActionResponse=CardService.newChatActionResponse().setResponseType(CardService.Type.REQUEST_CONFIG).setUrl('https://www.google.com');
Parameters
| Name | Type | Description |
|---|---|---|
url | String | The URL to send. |
Return
Chat — This object, for chaining.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.