Class ButtonSet
Page Summary
ButtonSet holds a set of Button objects displayed in a row.
ButtonSet is available for Google Workspace add-ons and Google Chat apps.
You can add a button to a ButtonSet using the
addButton()method.
Holds a set ofButton objects that are displayed in a row.
Available for Google Workspace add-ons and Google Chat apps.
consttextButton=CardService.newTextButton();// Finish building the text button...constimageButton=CardService.newImageButton();// Finish building the image button...constbuttonSet=CardService.newButtonSet().addButton(textButton).addButton(imageButton);
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Button | Adds a button. |
add | Widget | Adds the event action that can be performed on the widget. |
set | Widget | Sets the unique ID assigned that's used to identify the widget to be mutated. |
set | Widget | Sets the visibility of the widget. |
Detailed documentation
addButton(button)
addEventAction(eventAction)
Adds the event action that can be performed on the widget.
Parameters
| Name | Type | Description |
|---|---|---|
event | Event | TheEvent to be added. |
Return
Widget — The Object, for chaining.
setId(id)
Sets the unique ID assigned that's used to identify the widget to be mutated. Widget mutationis only supported in Add-Ons.
Parameters
| Name | Type | Description |
|---|---|---|
id | String | The id of the widget, with a limit of 64 characters and in format of `[a-zA-Z0-9-]+`. |
Return
Widget — This object, for chaining.
setVisibility(visibility)
Sets the visibility of the widget. The default value is `VISIBLE`.
Parameters
| Name | Type | Description |
|---|---|---|
visibility | Visibility | TheVisibility of the widget. |
Return
Widget — The 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.