# ShoppingList.Builder

# ShoppingList.Builder

*** ** * ** ***

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

<br />

```
public final class ShoppingList.Builder
```

<br />

*** ** * ** ***

Builder class for[ShoppingList](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList).

## Summary

|                                                      ### Public constructors                                                       |
|------------------------------------------------------------------------------------------------------------------------------------|
| [Builder](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder#Builder())`()` |

|                                                        ### Public methods                                                         |
|-----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ShoppingList.Builder](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addItemLabel](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder#addItemLabel(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` itemLabel)` Add a item label in the shopping list                                                                                                                                                                     |
| [ShoppingList.Builder](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addItemLabels](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder#addItemLabels(java.util.List<java.lang.String>))`(`[List](https://developer.android.com/reference/java/util/List.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`> itemLabels)` Add a list of item labels in the shopping list                                                                  |
| [ShoppingList.Builder](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addPosterImage](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder#addPosterImage(com.google.android.engage.common.datamodel.Image))`(`[Image](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Image)` image)` Adds a poster image of the items in the shopping list.                                                                                          |
| [ShoppingList.Builder](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addPosterImages](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder#addPosterImages(java.util.List<com.google.android.engage.common.datamodel.Image>))`(`[List](https://developer.android.com/reference/java/util/List.html)`<`[Image](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Image)`> images)` Adds poster images of the items in the shopping list. |
| [ShoppingList](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList)                 | [build](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder#build())`()`                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| [ShoppingList.Builder](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setActionLinkUri](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder#setActionLinkUri(android.net.Uri))`(`[Uri](https://developer.android.com/reference/android/net/Uri.html)` actionLinkUri)` Sets the action link uri for the shopping list.                                                                                                                                                    |
| [ShoppingList.Builder](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setActionText](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder#setActionText(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` actionText)` Sets the action text of the shopping cart. e.g. "View List"                                                                                                                                            |
| [ShoppingList.Builder](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setNumberOfItems](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder#setNumberOfItems(int))`(int numberOfItems)` Sets the number of items in the shopping list.                                                                                                                                                                                                                                   |
| [ShoppingList.Builder](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setTitle](https://developer.android.com/reference/com/google/android/engage/shopping/datamodel/ShoppingList.Builder#setTitle(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` title)` Sets the title of the shopping list.                                                                                                                                                                                  |

## Public constructors

### Builder

```
public Builder()
```  

## Public methods

### addItemLabel

```
@CanIgnoreReturnValue
public ShoppingList.Builder addItemLabel(String itemLabel)
```

Add a item label in the shopping list

Optional.  

### addItemLabels

```
@CanIgnoreReturnValue
public ShoppingList.Builder addItemLabels(List<String> itemLabels)
```

Add a list of item labels in the shopping list

Optional.  

### addPosterImage

```
@CanIgnoreReturnValue
public ShoppingList.Builder addPosterImage(Image image)
```

Adds a poster image of the items in the shopping list.

Optional.  

### addPosterImages

```
@CanIgnoreReturnValue
public ShoppingList.Builder addPosterImages(List<Image> images)
```

Adds poster images of the items in the shopping list.

Optional.  

### build

```
public ShoppingList build()
```  

### setActionLinkUri

```
@CanIgnoreReturnValue
public ShoppingList.Builder setActionLinkUri(Uri actionLinkUri)
```

Sets the action link uri for the shopping list.

Required.  

### setActionText

```
@CanIgnoreReturnValue
public ShoppingList.Builder setActionText(String actionText)
```

Sets the action text of the shopping cart. e.g. "View List"

Optional.  

### setNumberOfItems

```
@CanIgnoreReturnValue
public ShoppingList.Builder setNumberOfItems(int numberOfItems)
```

Sets the number of items in the shopping list.

When set to 0, the list is empty.

Optional.  

### setTitle

```
@CanIgnoreReturnValue
public ShoppingList.Builder setTitle(String title)
```

Sets the title of the shopping list.

Optional.