1// Copyright 2020 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.actions.sdk.v2.interactionmodel.prompt;
18
19import "google/actions/sdk/v2/interactionmodel/prompt/content/static_image_prompt.proto";
20import "google/api/field_behavior.proto";
21
22option go_package = "google.golang.org/genproto/googleapis/actions/sdk/v2/interactionmodel/prompt;prompt";
23option java_multiple_files = true;
24option java_outer_classname = "StaticListPromptProto";
25option java_package = "com.google.actions.sdk.v2.interactionmodel.prompt";
26
27// A card for presenting a list of options to select from.
28message StaticListPrompt {
29  // An item in the list.
30  message ListItem {
31    // Required. The NLU key that matches the entry key name in the associated type. When
32    // item tapped, this key will be posted back as a select option parameter.
33    string key = 1 [(google.api.field_behavior) = REQUIRED];
34
35    // Required. Title of the item. When tapped, this text will be posted back to the
36    // conversation verbatim as if the user had typed it. Each title must be
37    // unique among the set of items.
38    string title = 2 [(google.api.field_behavior) = REQUIRED];
39
40    // Optional. Body text of the item.
41    string description = 3 [(google.api.field_behavior) = OPTIONAL];
42
43    // Optional. Item image.
44    StaticImagePrompt image = 4 [(google.api.field_behavior) = OPTIONAL];
45  }
46
47  // Optional. Title of the list.
48  string title = 1 [(google.api.field_behavior) = OPTIONAL];
49
50  // Optional. Subtitle of the list.
51  string subtitle = 2 [(google.api.field_behavior) = OPTIONAL];
52
53  // Required. List items.
54  repeated ListItem items = 3 [(google.api.field_behavior) = REQUIRED];
55}
56