Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EventHandler
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EventHandler
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb
Overview
An event handler specifies an event that can be handled during a session. When
the specified event happens, the following actions are taken in order: * If
there is a trigger_fulfillment
associated with the event, it will be called.
- If there is a
target_page
associated with the event, the session will transition into the specified page. * If there is atarget_flow
associated with the event, the session will transition into the specified flow.
Instance Attribute Summary collapse
-
#event ⇒ String
Required.
-
#name ⇒ String
Output only.
-
#target_flow ⇒ String
The target flow to transition to.
-
#target_page ⇒ String
The target page to transition to.
-
#target_playbook ⇒ String
The target playbook to transition to.
-
#trigger_fulfillment ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Fulfillment
A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3EventHandler
constructor
A new instance of GoogleCloudDialogflowCxV3EventHandler.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3EventHandler
Returns a new instance of GoogleCloudDialogflowCxV3EventHandler.
2246 2247 2248 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2246 def initialize(**args) update!(**args) end |
Instance Attribute Details
#event ⇒ String
Required. The name of the event to handle.
Corresponds to the JSON property event
2210 2211 2212 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2210 def event @event end |
#name ⇒ String
Output only. The unique identifier of this event handler.
Corresponds to the JSON property name
2215 2216 2217 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2215 def name @name end |
#target_flow ⇒ String
The target flow to transition to. Format: projects//locations//agents//flows/
.
Corresponds to the JSON property targetFlow
2221 2222 2223 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2221 def target_flow @target_flow end |
#target_page ⇒ String
The target page to transition to. Format: projects//locations//agents//flows//
pages/
.
Corresponds to the JSON property targetPage
2227 2228 2229 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2227 def target_page @target_page end |
#target_playbook ⇒ String
The target playbook to transition to. Format: projects//locations//agents//
playbooks/
.
Corresponds to the JSON property targetPlaybook
2233 2234 2235 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2233 def target_playbook @target_playbook end |
#trigger_fulfillment ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Fulfillment
A fulfillment can do one or more of the following actions at the same time: *
Generate rich message responses. * Set parameter values. * Call the webhook.
Fulfillments can be called at various stages in the Page or Form lifecycle.
For example, when a DetectIntentRequest drives a session to enter a new page,
the page's entry fulfillment can add a static response to the QueryResult in
the returning DetectIntentResponse, call the webhook (for example, to load
user data from a database), or both.
Corresponds to the JSON property triggerFulfillment
2244 2245 2246 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2244 def trigger_fulfillment @trigger_fulfillment end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2251 2252 2253 2254 2255 2256 2257 2258 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2251 def update!(**args) @event = args[:event] if args.key?(:event) @name = args[:name] if args.key?(:name) @target_flow = args[:target_flow] if args.key?(:target_flow) @target_page = args[:target_page] if args.key?(:target_page) @target_playbook = args[:target_playbook] if args.key?(:target_playbook) @trigger_fulfillment = args[:trigger_fulfillment] if args.key?(:trigger_fulfillment) end |