com.google.actions.api.response.helperintent

Class SelectionList

com.google.actions.api.response.helperintent.SelectionList

All Implemented Interfaces:

HelperIntent

public class SelectionList
implements HelperIntent

Helper intent response to collect user's input with a list.

List items = new ArrayList<>();
ListSelectListItem item;
for (int i = 0; i < 3; i++) {
  item = new ListSelectListItem();
  item.setTitle("Item #" + (i + 1))
      .setDescription("Description of Item #" + (i + 1))
      .setImage(new Image()
      .setUrl(IMAGES[i])
      .setAccessibilityText("Image alt text"))
      .setOptionInfo(new OptionInfo()
        .setKey(String.valueOf(i + 1)));
  items.add(item);
}
responseBuilder
  .add("This is the first simple response for a list.")
  .add(new SelectionList().setTitle("List title").setItems(items));

The following code demonstrates how to get the user's selection:

@ForIntent("item selected")
public CompletableFuture itemSelected(ActionRequest request) {
  ResponseBuilder responseBuilder = getResponseBuilder();
  String selectedItem = request.getArgument("OPTION").getTextValue();
  responseBuilder
    .add("You selected: " + selectedItem);
  return CompletableFuture.completedFuture(responseBuilder.build());
}

Constructor Summary

Constructors

Constructor and Description
SelectionList() Helper intent response to collect user's input with a list.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
java.util.Map<java.lang.String,java.lang.Object>	getParameters()
SelectionList	setItems(java.util.List<com.google.api.services.actions_fulfillment.v2.model.ListSelectListItem> items)
SelectionList	setTitle(java.lang.String title)

Methods inherited from interface com.google.actions.api.response.helperintent.HelperIntent

getName, getParameters

Constructor Detail

SelectionList

public SelectionList()

Helper intent response to collect user's input with a list.

List items = new ArrayList<>();
ListSelectListItem item;
for (int i = 0; i < 3; i++) {
  item = new ListSelectListItem();
  item.setTitle("Item #" + (i + 1))
      .setDescription("Description of Item #" + (i + 1))
      .setImage(new Image()
      .setUrl(IMAGES[i])
      .setAccessibilityText("Image alt text"))
      .setOptionInfo(new OptionInfo()
        .setKey(String.valueOf(i + 1)));
  items.add(item);
}
responseBuilder
  .add("This is the first simple response for a list.")
  .add(new SelectionList().setTitle("List title").setItems(items));

The following code demonstrates how to get the user's selection:

@ForIntent("item selected")
public CompletableFuture itemSelected(ActionRequest request) {
  ResponseBuilder responseBuilder = getResponseBuilder();
  String selectedItem = request.getArgument("OPTION").getTextValue();
  responseBuilder
    .add("You selected: " + selectedItem);
  return CompletableFuture.completedFuture(responseBuilder.build());
}

Method Detail

setTitle

public SelectionList setTitle(java.lang.String title)

setItems

public SelectionList setItems(java.util.List<com.google.api.services.actions_fulfillment.v2.model.ListSelectListItem> items)

getName

public java.lang.String getName()

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()