# ShoppingList

# ShoppingList

*** ** * ** ***

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

<br />

```
public final class ShoppingList
```

<br />

*** ** * ** ***

An object representing a Shopping List for shopping vertical.

## Summary

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

|                                                                             ### Public methods                                                                             |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Uri](https://developer.android.com/reference/android/net/Uri.html)                                                                                                        | [getActionLinkUri](https://developer.android.com/reference/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://developer.android.com/reference/java/lang/String.html)`>`     | [getActionText](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList#getActionText())`()` Returns the action text of the shopping list. e.g. "View List"   |
| `int`                                                                                                                                                                      | [getClusterType](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList#getClusterType())`()`                                                                |
| [List](https://developer.android.com/reference/java/util/List.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`>`                           | [getItemLabels](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList#getItemLabels())`()` Returns the labels of the items in the shopping list             |
| `int`                                                                                                                                                                      | [getNumberOfItems](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList#getNumberOfItems())`()` Returns the number of items in the shopping list.          |
| [List](https://developer.android.com/reference/java/util/List.html)`<`[Image](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Image)`>` | [getPosterImages](https://developer.android.com/reference/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://developer.android.com/reference/java/lang/String.html)`>`     | [getTitle](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList#getTitle())`()` Returns the title of the shopping list.                                    |

## Public methods

### getActionLinkUri

```
public Uri getActionLinkUri()
```

Returns the action link of the shopping list.  

### getActionText

```
public Optional<String> getActionText()
```

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

### getClusterType

```
public int getClusterType()
```  

### getItemLabels

```
public List<String> getItemLabels()
```

Returns the labels of the items in the shopping list  

### getNumberOfItems

```
public int getNumberOfItems()
```

Returns the number of items in the shopping list.  

### getPosterImages

```
public List<Image> getPosterImages()
```

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

### getTitle

```
public Optional<String> getTitle()
```

Returns the title of the shopping list.