xref: /aosp_15_r20/external/googleapis/google/actions/sdk/v2/interactionmodel/prompt/surface_capabilities.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
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/api/field_behavior.proto";
20
21option go_package = "google.golang.org/genproto/googleapis/actions/sdk/v2/interactionmodel/prompt;prompt";
22option java_multiple_files = true;
23option java_outer_classname = "SurfaceCapabilitiesProto";
24option java_package = "com.google.actions.sdk.v2.interactionmodel.prompt";
25
26// Represents the surface the user is using to make a request to the Action.
27message SurfaceCapabilities {
28  // Capabilities the device surface supports at the time of the request.
29  enum Capability {
30    // Unspecified surface capability.
31    UNSPECIFIED = 0;
32
33    // Device can speak to the user via text-to-speech or SSML.
34    SPEECH = 1;
35
36    // Device can display rich responses like cards, lists and tables.
37    RICH_RESPONSE = 2;
38
39    // Device can play long form audio media like music and podcasts.
40    LONG_FORM_AUDIO = 3;
41
42    // Device can display a interactive canvas response.
43    INTERACTIVE_CANVAS = 4;
44
45    // Device can use web links in rich responses to open a web browser.
46    WEB_LINK = 5;
47
48    // Device can support saving and fetching home storage.
49    HOME_STORAGE = 6;
50  }
51
52  // Required. The capabilities of the surface making a request to the Action.
53  repeated Capability capabilities = 1 [(google.api.field_behavior) = REQUIRED];
54}
55