ListContainer

Container for list items, where each list item can contain multiple `https://developers.google.com/apps-script/reference/add-ons-response-service/text-format-element`. \*

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

```javascript
const listContainer = AddOnsResponseService.newListContainer()
      .setListType(AddOnsResponseService.ListType.UNORDERED)
      .addListItem(
        AddOnsResponseService.newListItem()
          .addTextFormatElement(
            AddOnsResponseService.newTextFormatElement()
              .setStyledText(sampleStyledText)
          ));
```

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/add-ons-response-service/list-container#addListItem(ListItem)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/list-container#` | Adds a list item to the list container. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/list-container#setListNestLevel(Integer)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/list-container#` | Sets the level of the list, starts from 0 for the top level, and increases by 1 for each nested list. |
| `https://developers.google.com/apps-script/reference/add-ons-response-service/list-container#setListType(ListType)` | `https://developers.google.com/apps-script/reference/add-ons-response-service/list-container#` | Sets the type of the list to be ordered or unordered. |

## Detailed documentation

### `addListItem(listItem)`

Adds a list item to the list container.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `listItem` | `https://developers.google.com/apps-script/reference/add-ons-response-service/list-item` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/list-item` to be added to the list container. |

#### Return


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

*** ** * ** ***

### `setListNestLevel(listLevel)`

Sets the level of the list, starts from 0 for the top level, and increases by 1 for each nested
list.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `listLevel` | `Integer` | The number of nest levels of the list. |

#### Return


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

*** ** * ** ***

### `setListType(listType)`

Sets the type of the list to be ordered or unordered.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `listType` | `https://developers.google.com/apps-script/reference/add-ons-response-service/list-type` | The `https://developers.google.com/apps-script/reference/add-ons-response-service/list-type` of the list. |

#### Return


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