Class ButtonSet

  • 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.

const textButton = CardService.newTextButton();
// Finish building the text button...

const imageButton = CardService.newImageButton();
// Finish building the image button...

const buttonSet =
    CardService.newButtonSet().addButton(textButton).addButton(imageButton);

Methods

MethodReturn typeBrief description
addButton(button)ButtonSetAdds a button.
addEventAction(eventAction)WidgetAdds the event action that can be performed on the widget.
setId(id)WidgetSets the unique ID assigned that's used to identify the widget to be mutated.
setVisibility(visibility)WidgetSets the visibility of the widget.

Detailed documentation

addButton(button)

Adds a button.

Parameters

NameTypeDescription
buttonButtonThe button to add.

Return

ButtonSet — This object, for chaining.


addEventAction(eventAction)

Adds the event action that can be performed on the widget.

Parameters

NameTypeDescription
eventActionEventActionThe EventAction 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

NameTypeDescription
idStringThe 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

NameTypeDescription
visibilityVisibilityThe Visibility of the widget.

Return

Widget — The Object, for chaining.