xref: /aosp_15_r20/external/googleapis/google/actions/sdk/v2/interactionmodel/global_intent_event.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;
18
19import "google/actions/sdk/v2/interactionmodel/event_handler.proto";
20import "google/api/field_behavior.proto";
21
22option go_package = "google.golang.org/genproto/googleapis/actions/sdk/v2/interactionmodel;interactionmodel";
23option java_multiple_files = true;
24option java_outer_classname = "GlobalIntentEventProto";
25option java_package = "com.google.actions.sdk.v2.interactionmodel";
26
27// Defines a global intent handler. Global intent events are scoped to the
28// entire Actions project and may be overridden by intent handlers in a scene.
29// Intent names must be unique within an Actions project.
30//
31// Global intents can be matched anytime during a session, allowing users to
32// access common flows like  "get help" or "go back home." They can also be
33// used to deep link users into specific flows when they invoke an Action.
34//
35// Note, the intent name is specified in the name of the file.
36message GlobalIntentEvent {
37  // Optional. Destination scene which the conversation should jump to. The state of the
38  // current scene is destroyed on the transition.
39  string transition_to_scene = 1 [(google.api.field_behavior) = OPTIONAL];
40
41  // Optional. Event handler which is triggered when the intent is matched. Should execute
42  // before transitioning to the destination scene. Useful to generate Prompts
43  // in response to events.
44  EventHandler handler = 2 [(google.api.field_behavior) = OPTIONAL];
45}
46