Class ButtonSet
Stay organized with collections
Save and categorize content based on your preferences.
Spark icon
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.
ButtonSet
Holds a set of Button 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 | The Event 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 mutation is 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 | The Visibility of the widget. |
Return
Widget — The Object, for chaining.