Class InsertWidget
Stay organized with collections
Save and categorize content based on your preferences.
A builder for InsertWidget objects. Developers cans insert a widget into a card by passing a
Insert to Modify
Only available for Google Workspace add-ons that extend Google Workspace Studio.
Sample usage:
constnewWidget=CardService.newDecoratedText().setText('New Widget'); constinsertWidget=AddOnsResponseService.newInsertWidget() .insertAboveWidget('sample_id') .setWidget(newWidget); constmodifyCard=AddOnsResponseService.newModifyCard().setInsertWidget(insertWidget);
Methods
| Method | Return type | Brief description |
|---|---|---|
insert | Insert | Sets the widget ID, and the new widget is inserted above the widget with the given ID. |
insert | Insert | Sets the widget ID, and the new widget is inserted below the widget with the given ID. |
set | Insert | Sets the Widget to be inserted. |
Detailed documentation
insertAboveWidget(widgetId)
Sets the widget ID, and the new widget is inserted above the widget with the given ID. An error is thrown if the widget ID is not found.
Parameters
| Name | Type | Description |
|---|---|---|
widget | String | The ID of the widget to insert above. |
Return
Insert — The insert widget object, for chaining.
insertBelowWidget(widgetId)
Sets the widget ID, and the new widget is inserted below the widget with the given ID. An error is thrown if the widget ID is not found.
Parameters
| Name | Type | Description |
|---|---|---|
widget | String | The ID of the widget to insert below. |
Return
Insert — The insert widget object, for chaining.
setWidget(widget)
Sets the Widget to be inserted. An error is thrown if there is a existing widget with
the same ID.
Parameters
| Name | Type | Description |
|---|---|---|
widget | Widget | The widget to be inserted. |
Return
Insert — The insert widget object, for chaining.