ActionResponseBuilder

A builder for `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response` objects.

Available for Google Workspace add-ons.

```javascript
const notification = AddOnsResponseService.newNotification().setText("You closed a dialog!");

const navigation = AddOnsResponseService.newNavigation()
    .setEndNavigation(AddOnsResponseService.EndNavigation.CLOSE_DIALOG);

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(navigation)
    .setNotification(notification)
    .build();
```

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#addModifyCard(ModifyCard)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#` | Sets the modify card operation to the action. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#build()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response` | Builds the current action response and validates it. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#setLinkPreview(LinkPreview)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#` | Sets the LinkPreview to the action. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#setNavigation(Navigation)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#` | Sets the response to a `https://developers.google.com/apps-script/reference/add-ons-response-service/navigation` action. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#setNotification(Notification)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#` | Sets the notification to display when the action is activated. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#setOpenLink(OpenLink)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#` | Sets the URL to navigate to when the action is activated. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#setStateChanged(Boolean)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder#` | Sets a flag to indicate that this action changed the existing data state. |

## Detailed documentation

### `addModifyCard(modifyCard)`

Sets the modify card operation to the action.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `modifyCard` | `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/modify-card` to use. |

#### Return


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

*** ** * ** ***

### `build()`

Builds the current action response and validates it.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/action-response` --- A validated ActionResponse.

#### Throws


[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the constructed action response isn't valid.

*** ** * ** ***

### `setLinkPreview(linkPreview)`

Sets the LinkPreview to the action.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `linkPreview` | `https://developers.google.com/apps-script/reference/add-ons-response-service/link-preview` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/link-preview` to use. |

#### Return


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

*** ** * ** ***

### `setNavigation(navigation)`

Sets the response to a `https://developers.google.com/apps-script/reference/add-ons-response-service/navigation` action.

```javascript
const navigation = AddOnsResponseService.newNavigation()
    .setEndNavigation(AddOnsResponseService.EndNavigation.CLOSE_DIALOG);

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(navigation)
    .build();
```

#### Parameters

| Name | Type | Description |
|---|---|---|
| `navigation` | `https://developers.google.com/apps-script/reference/add-ons-response-service/navigation` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/navigation` to use. |

#### Return


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

*** ** * ** ***

### `setNotification(notification)`

Sets the notification to display when the action is activated.

```javascript
const notification = AddOnsResponseService.newNotification().setText("You closed a dialog!");

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNotification(notification)
    .build();
```

#### Parameters

| Name | Type | Description |
|---|---|---|
| `notification` | `https://developers.google.com/apps-script/reference/add-ons-response-service/notification` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/notification` to use. |

#### Return


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

*** ** * ** ***

### `setOpenLink(openLink)`

Sets the URL to navigate to when the action is activated.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `openLink` | `https://developers.google.com/apps-script/reference/add-ons-response-service/open-link` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/open-link` to use. |

#### Return


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

*** ** * ** ***

### `setStateChanged(stateChanged)`

Sets a flag to indicate that this action changed the existing data state. For example, if the
action created a task or updated contact information. When this flag is set to `true`,
services such as Gmail can attempt to clear any cached state data associated with this action.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `stateChanged` | `Boolean` | Whether this action has changed the existing state data. Defaults to `false`. |

#### Return


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