AddOnsResponseService


`AddOnsResponseService` provides the ability to create responses for Google Workspace
add-ons.

Sample usage:

```javascript
function myFunction() {
  return AddOnsResponseService.newChatDataActionBuilder();
}
```

The following example shows how a Chat app responds with a dialog:

```
const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle("Card Title"))
    .addSection(CardService.newCardSection()
      .addWidget(CardService.newTextParagraph().setText("Text paragraph")))
    .build();

const actionResponse = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(AddOnsResponseService.newNavigation().pushCard(card))
    .build();
```

The following example shows how a Chat app responds with a link preview card:

```
const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle("Unfurl Card!"))
    .addSection(CardService.newCardSection()
      .addWidget(CardService.newTextParagraph().setText("url"))
      .addWidget(CardService.newButtonSet()
        .addButton(CardService.newTextButton()
          .setText("Open URL!")
          .setOpenLink(CardService.newOpenLink().setUrl("https://www.google.com")))))
    .build();

const cardWithId = CardService.newCardWithId().setCardId("card_one").setCard(card);

const chatDataAction = AddOnsResponseService.newChatDataActionBuilder()
    .setUpdateInlinePreviewAction(AddOnsResponseService.newUpdateInlinePreviewAction()
    .addCardWithId(cardWithId)).build();
```

### Properties

| Property | Type | Description |
|---|---|---|
| `AddonComposeUiActionType` | `https://developers.google.com/apps-script/reference/add-ons-response-service/addon-compose-ui-action-type` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/addon-compose-ui-action-type` enumeration. |
| `ComposedEmailType` | `https://developers.google.com/apps-script/reference/add-ons-response-service/composed-email-type` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/composed-email-type` enumeration. |
| `ContentType` | `https://developers.google.com/apps-script/reference/add-ons-response-service/content-type` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/content-type` enumeration. |
| `EndNavigation` | `https://developers.google.com/apps-script/reference/add-ons-response-service/end-navigation` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/end-navigation` enumeration. |
| `OnClose` | `https://developers.google.com/apps-script/reference/add-ons-response-service/on-close` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/on-close` enumeration. |
| `OpenAs` | `https://developers.google.com/apps-script/reference/add-ons-response-service/open-as` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/open-as` enumeration. |
| `SendStatus` | `https://developers.google.com/apps-script/reference/add-ons-response-service/send-status` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/send-status` enumeration. |
| `UpdateDraftBodyType` | `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-body-type` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-body-type` enumeration. |

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newAccessoryWidget()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/accessory-widget` | Creates a new `https://developers.google.com/apps-script/reference/add-ons-response-service/accessory-widget`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newAction()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/action` | Creates a new `https://developers.google.com/apps-script/reference/add-ons-response-service/action`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newActionResponseBuilder()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newAddonComposeUiActionResponseBuilder()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/addon-compose-ui-action-response-builder` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/addon-compose-ui-action-response-builder`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newAttachment()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/attachment` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/attachment`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newCalendarEventActionResponseBuilder()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/calendar-event-action-response-builder` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/calendar-event-action-response-builder`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newChatDataActionBuilder()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/chat-data-actions-response-builder` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/chat-data-actions-response-builder`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newChatMessage()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/chat-message` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/chat-message`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newComposeActionResponseBuilder()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/compose-action-response-builder` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/compose-action-response-builder`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newCreateMessageAction()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/create-message-action` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/create-message-action`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newDriveItemsSelectedActionResponseBuilder()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/drive-items-selected-action-response-builder` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/drive-items-selected-action-response-builder`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newEditorFileScopeActionResponseBuilder()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/editor-file-scope-action-response-builder` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/editor-file-scope-action-response-builder`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newLinkPreview()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/link-preview` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/link-preview`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newNavigation()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/navigation` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/navigation`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newNotification()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/notification` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/notification`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newOpenLink()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/open-link` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/open-link`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newRenderActionBuilder()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/render-action-builder` | Creates a new `https://developers.google.com/apps-script/reference/add-ons-response-service/render-action-builder`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newUniversalActionResponseBuilder()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/universal-action-response-builder` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/universal-action-response-builder`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newUpdateDraftActionResponseBuilder()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-action-response-builder` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-action-response-builder`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newUpdateDraftBccRecipientsAction()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-bcc-recipients-action` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-bcc-recipients-action`; |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newUpdateDraftBodyAction()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-body-action` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-body-action`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newUpdateDraftCcRecipientsAction()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-cc-recipients-action` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-cc-recipients-action`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newUpdateDraftSubjectAction()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-subject-action` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-subject-action`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newUpdateDraftToRecipientsAction()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-to-recipients-action` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-to-recipients-action`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newUpdateInlinePreviewAction()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/update-inline-preview-action` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-inline-preview-action`. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/add-ons-response-service#newUpdateMessageAction()` | `https://developers.google.com/apps-script/reference/add-ons-response-service/update-message-action` | Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-message-action`. |

## Detailed documentation

### `newAccessoryWidget()`

Creates a new `https://developers.google.com/apps-script/reference/add-ons-response-service/accessory-widget`.

```javascript
const widget = CardService.newButtonSet()
    .addButton(CardService.newImageButton()
      .setIcon(CardService.Icon.PHONE)
      .setOnClickAction(CardService.newAction()
        .setFunctionName("phone")))
    .addButton(CardService.newTextButton()
      .setText("Robot")
      .setIconUrl("https://developers.google.com/chat/images/quickstart-app-avatar.png")
      .setOnClickAction(CardService.newAction()
        .setFunctionName("robot")));

const accessoryWidget = AddOnsResponseService.newAccessoryWidget()
    .addWidget(widget);
```

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/accessory-widget` --- An empty AccessoryWidget.

*** ** * ** ***

### `newAction()`

Creates a new `https://developers.google.com/apps-script/reference/add-ons-response-service/action`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/action` --- An empty Action.

*** ** * ** ***

### `newActionResponseBuilder()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder`.

```javascript
const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle("Card Title"))
    .addSection(CardService.newCardSection()
      .addWidget(CardService.newTextParagraph().setText("Text paragraph")))
    .build();

const actionResponse = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(AddOnsResponseService.newNavigation().pushCard(card))
    .build();
```

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/action-response-builder` --- An empty ActionResponse builder.

*** ** * ** ***

### `newAddonComposeUiActionResponseBuilder()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/addon-compose-ui-action-response-builder`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/addon-compose-ui-action-response-builder` --- An empty AddonComposeUiActionResponseBuilder.

*** ** * ** ***

### `newAttachment()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/attachment`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/attachment` --- An empty attachment.

*** ** * ** ***

### `newCalendarEventActionResponseBuilder()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/calendar-event-action-response-builder`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/calendar-event-action-response-builder` --- An empty `https://developers.google.com/apps-script/reference/add-ons-response-service/calendar-event-action-response-builder`.

*** ** * ** ***

### `newChatDataActionBuilder()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/chat-data-actions-response-builder`.

```javascript
const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle("Card Title"))
    .addSection(CardService.newCardSection()
      .addWidget(CardService.newTextParagraph().setText("Text paragraph")))
    .build();

const cardWithId = CardService.newCardWithId().setCardId("card_one").setCard(card);

const message = AddOnsResponseService.newChatMessage().addCardWithId(cardWithId);

const chatDataAction = AddOnsResponseService.newChatDataActionBuilder()
    .setCreateChatMessageAction(AddOnsResponseService.newCreateMessageAction()
    .setMessage(message))
    .build();
```

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/chat-data-actions-response-builder` --- An empty ChatDataActionsResponseBuilder.

*** ** * ** ***

### `newChatMessage()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/chat-message`.

```javascript
const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle("Card Title"))
    .addSection(CardService.newCardSection()
      .addWidget(CardService.newTextParagraph().setText("Text paragraph")))
    .build();

const cardWithId = CardService.newCardWithId().setCardId("card_one").setCard(card);

const message = AddOnsResponseService.newChatMessage().addCardWithId(cardWithId);
```

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/chat-message` --- An empty ChatMessage.

*** ** * ** ***

### `newComposeActionResponseBuilder()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/compose-action-response-builder`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/compose-action-response-builder` --- An empty ComposeActionResponse builder.

*** ** * ** ***

### `newCreateMessageAction()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/create-message-action`.

```javascript
const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle("Card Title"))
    .addSection(CardService.newCardSection()
      .addWidget(CardService.newTextParagraph().setText("Text paragraph")))
    .build();

const cardWithId = CardService.newCardWithId().setCardId("card_one").setCard(card);

const message = AddOnsResponseService.newChatMessage().addCardWithId(cardWithId);

const chatDataAction = AddOnsResponseService.newChatDataActionBuilder()
    .setCreateChatMessageAction(AddOnsResponseService.newCreateMessageAction()
    .setMessage(message))
    .build();
```

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/create-message-action` --- An empty CreateMessageAction.

*** ** * ** ***

### `newDriveItemsSelectedActionResponseBuilder()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/drive-items-selected-action-response-builder`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/drive-items-selected-action-response-builder` --- An empty `https://developers.google.com/apps-script/reference/add-ons-response-service/drive-items-selected-action-response-builder`.

*** ** * ** ***

### `newEditorFileScopeActionResponseBuilder()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/editor-file-scope-action-response-builder`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/editor-file-scope-action-response-builder` --- An empty `https://developers.google.com/apps-script/reference/add-ons-response-service/editor-file-scope-action-response-builder`.

*** ** * ** ***

### `newLinkPreview()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/link-preview`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/link-preview` --- An empty LinkPreview.

*** ** * ** ***

### `newNavigation()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/navigation`.

```javascript
const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle('Card title'))
    .addSection(cardSection)
    .build();

const navigation = AddOnsResponseService.newNavigation()
    .pushCard(card);
```

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/navigation` --- An empty Navigation.

*** ** * ** ***

### `newNotification()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/notification`.

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

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

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/notification` --- An empty Notification.

*** ** * ** ***

### `newOpenLink()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/open-link`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/open-link` --- An empty OpenLink.

*** ** * ** ***

### `newRenderActionBuilder()`

Creates a new `https://developers.google.com/apps-script/reference/add-ons-response-service/render-action-builder`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/render-action-builder` --- An empty RenderActionBuilder.

*** ** * ** ***

### `newUniversalActionResponseBuilder()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/universal-action-response-builder`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/universal-action-response-builder` --- An empty UniversalActionResponse builder.

*** ** * ** ***

### `newUpdateDraftActionResponseBuilder()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-action-response-builder`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-action-response-builder` --- An empty UpdateDraftActionResponseBuilder.

*** ** * ** ***

### `newUpdateDraftBccRecipientsAction()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-bcc-recipients-action`;

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-bcc-recipients-action` --- An empty UpdateDraftBccRecipientsAction.

*** ** * ** ***

### `newUpdateDraftBodyAction()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-body-action`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-body-action` --- An empty UpdateDraftBodyAction.

*** ** * ** ***

### `newUpdateDraftCcRecipientsAction()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-cc-recipients-action`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-cc-recipients-action` --- An Empty UpdateDraftCcRecipientsAction.

*** ** * ** ***

### `newUpdateDraftSubjectAction()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-subject-action`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-subject-action` --- An empty UpdateDraftSubjectAction.

*** ** * ** ***

### `newUpdateDraftToRecipientsAction()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-to-recipients-action`.

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/update-draft-to-recipients-action` --- An empty UpdateDraftToRecipientsAction.

*** ** * ** ***

### `newUpdateInlinePreviewAction()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-inline-preview-action`.

```javascript
const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle("Unfurl Card!"))
    .addSection(CardService.newCardSection()
      .addWidget(CardService.newTextParagraph().setText("url"))
      .addWidget(CardService.newButtonSet()
        .addButton(CardService.newTextButton()
          .setText("Open URL!")
          .setOpenLink(CardService.newOpenLink().setUrl("https://www.google.com")))))
    .build();

const cardWithId = CardService.newCardWithId().setCardId("card_one").setCard(card);

const chatDataAction = AddOnsResponseService.newChatDataActionBuilder()
    .setUpdateInlinePreviewAction(AddOnsResponseService.newUpdateInlinePreviewAction()
    .addCardWithId(cardWithId)).build();
```

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/update-inline-preview-action` --- An empty UpdateInlinePreviewAction.

*** ** * ** ***

### `newUpdateMessageAction()`

Creates a `https://developers.google.com/apps-script/reference/add-ons-response-service/update-message-action`.

```javascript
const card = CardService.newCardBuilder()
    .setHeader(CardService.newCardHeader().setTitle("Card Title"))
    .addSection(CardService.newCardSection()
      .addWidget(CardService.newTextParagraph().setText("Text paragraph")))
    .build();

const cardWithId = CardService.newCardWithId().setCardId("card_one").setCard(card);

const message = AddOnsResponseService.newChatMessage().addCardWithId(cardWithId);

const chatDataAction = AddOnsResponseService.newChatDataActionBuilder()
    .setUpdateChatMessageAction(AddOnsResponseService.newUpdateMessageAction()
    .setMessage(message))
    .build();
```

#### Return


`https://developers.google.com/apps-script/reference/add-ons-response-service/update-message-action` --- An empty UpdateMessageAction.