Class UpdateWidget

UpdateWidget

A builder for UpdateWidget objects. Developers can update a widget in the card by passing a UpdateWidget to ModifyCard

Only available for Google Workspace add-ons that extend Google Workspace Studio.

Methods

MethodReturn typeBrief description
addSuggestion(text, value, selected, startIconUri, bottomText)UpdateWidgetAdds a new item that can be selected, for multi-select menus.

Detailed documentation

addSuggestion(text, value, selected, startIconUri, bottomText)

Adds a new item that can be selected, for multi-select menus.

Parameters

NameTypeDescription
textObjectThe text to be shown for this item. Non-string primitive arguments are converted to strings automatically.
valueObjectThe form input value that is sent via the callback. Non-string primitive arguments are converted to strings automatically.
selectedBooleanWhether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
startIconUriObjectFor multiselect menus, the URL for the icon displayed next to the item's text field. Supports PNG and JPEG files.
bottomTextObjectFor multiselect menus, a text description or label that's displayed below the item's text field.

Return

UpdateWidget — This update widget object, for chaining.