# ShoppingList

# ShoppingList

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList "View this page in Java")  

<br />

```
class ShoppingList
```

<br />

*** ** * ** ***

An object representing a Shopping List for shopping vertical.

## Summary

|                                                                                                                                      ### Nested types                                                                                                                                       |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[ShoppingList.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingList.Builder) Builder class for[ShoppingList](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingList). |

|                                                                                                                                               ### Public functions                                                                                                                                                |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Uri](https://developer.android.com/reference/android/net/Uri.html)`!`                                                                                                                                                                                                                                            | [getActionLinkUri](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingList#getActionLinkUri())`()` Returns the action link of the shopping list.              |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                 | [getActionText](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingList#getActionText())`()` Returns the action text of the shopping list. e.g. "View List"   |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                                                                                                                                                                                                                                        | [getClusterType](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingList#getClusterType())`()`                                                                |
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                         | [getItemLabels](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingList#getItemLabels())`()` Returns the labels of the items in the shopping list             |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                                                                                                                                                                                                                                        | [getNumberOfItems](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingList#getNumberOfItems())`()` Returns the number of items in the shopping list.          |
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[Image](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Image)`!>!` | [getPosterImages](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingList#getPosterImages())`()` Returns the poster images of the items in the shopping list. |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                 | [getTitle](https://developer.android.com/reference/kotlin/com/google/android/engage/shopping/datamodel/ShoppingList#getTitle())`()` Returns the title of the shopping list.                                    |

## Public functions

### getActionLinkUri

```
fun getActionLinkUri(): Uri!
```

Returns the action link of the shopping list.  

### getActionText

```
fun getActionText(): Optional<String!>!
```

Returns the action text of the shopping list. e.g. "View List"  

### getClusterType

```
fun getClusterType(): Int
```  

### getItemLabels

```
fun getItemLabels(): (Mutable)List<String!>!
```

Returns the labels of the items in the shopping list  

### getNumberOfItems

```
fun getNumberOfItems(): Int
```

Returns the number of items in the shopping list.  

### getPosterImages

```
fun getPosterImages(): (Mutable)List<Image!>!
```

Returns the poster images of the items in the shopping list.  

### getTitle

```
fun getTitle(): Optional<String!>!
```

Returns the title of the shopping list.