ModifyCard

A builder for `ModifyCard` objects that changes and updates an existing card's
interface by passing the `ModifyCard` object to a `https://developers.google.com/apps-script/reference/add-ons-response-service/action`. For usage, see [Update configuration cards](https://developers.google.com/workspace/add-ons/studio/update-cards).

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

Sample usage:

```javascript
const insertSection = AddOnsResponseService.newInsertSection().insertBelowSection('sample_id')
.setSection(CardService.newCardSection().setHeader('New Section'));

const modifyCard = AddOnsResponseService.newModifyCard().setInsertSection(insertSection);

const navigation = AddOnsResponseService.newNavigation().addModifyCard(modifyCard);
```

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#setInsertSection(InsertSection)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` | Sets the `https://developers.google.com/apps-script/reference/add-ons-response-service/insert-section` for this modify card object. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#setInsertWidget(InsertWidget)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` | Sets the `https://developers.google.com/apps-script/reference/add-ons-response-service/insert-widget` for this modify card object. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#setRemoveSection(RemoveSection)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` | Sets the `https://developers.google.com/apps-script/reference/add-ons-response-service/remove-section` for this modify card object. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#setRemoveWidget(RemoveWidget)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` | Sets the `https://developers.google.com/apps-script/reference/add-ons-response-service/remove-widget` for this modify card object. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#setReplaceSection(CardSection)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` | Sets the replacement `https://developers.google.com/apps-script/reference/card-service/card-section.html` for this modify card object, the replacement section should have the same id as an existing card section. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#setReplaceWidget(Widget)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` | Sets the replacement widget for this modify card object, the replacement widget should have the same id as an existing widget. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#setUpdateWidget(UpdateWidget)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` | Sets the `https://developers.google.com/apps-script/reference/add-ons-response-service/update-widget` for this modify card object. |

## Detailed documentation

### `setInsertSection(insertSection)`

Sets the `https://developers.google.com/apps-script/reference/add-ons-response-service/insert-section` for this modify card object.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `insertSection` | `https://developers.google.com/apps-script/reference/add-ons-response-service/insert-section` | The insert section to apply to the card. |

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` --- This modify card object, for chaining.

*** ** * ** ***

### `setInsertWidget(insertWidget)`

Sets the `https://developers.google.com/apps-script/reference/add-ons-response-service/insert-widget` for this modify card object.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `insertWidget` | `https://developers.google.com/apps-script/reference/add-ons-response-service/insert-widget` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/insert-widget` to apply to the card. |

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` --- This modify card object, for chaining.

*** ** * ** ***

### `setRemoveSection(removeSection)`

Sets the `https://developers.google.com/apps-script/reference/add-ons-response-service/remove-section` for this modify card object.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `removeSection` | `https://developers.google.com/apps-script/reference/add-ons-response-service/remove-section` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/remove-section` to apply to the card. |

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` --- This modify card object, for chaining.

*** ** * ** ***

### `setRemoveWidget(removeWidget)`

Sets the `https://developers.google.com/apps-script/reference/add-ons-response-service/remove-widget` for this modify card object.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `removeWidget` | `https://developers.google.com/apps-script/reference/add-ons-response-service/remove-widget` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/remove-widget` to apply to the card. |

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` --- This modify card object, for chaining.

*** ** * ** ***

### `setReplaceSection(replacementSection)`

Sets the replacement `https://developers.google.com/apps-script/reference/card-service/card-section.html` for this modify card object, the replacement section
should have the same id as an existing card section.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `replacementSection` | `https://developers.google.com/apps-script/reference/card-service/card-section.html` | The replacement section to overwrite an existing card section. |

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` --- This modify card object, for chaining.

*** ** * ** ***

### `setReplaceWidget(replacementWidget)`

Sets the replacement widget for this modify card object, the replacement widget should have the
same id as an existing widget.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `replacementWidget` | `https://developers.google.com/apps-script/reference/card-service/widget.html` | The replacement widget to overwrite an existing widget. |

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` --- This modify card object, for chaining.

*** ** * ** ***

### `setUpdateWidget(updateWidget)`

Sets the `https://developers.google.com/apps-script/reference/add-ons-response-service/update-widget` for this modify card object.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `updateWidget` | `https://developers.google.com/apps-script/reference/add-ons-response-service/update-widget` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/update-widget` to apply to the card. |

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card#` --- This modify card object, for chaining.