Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EventHandler

Inherits:
Object
  • Object
show all
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 a target_flow associated with the event, the session will transition into the specified flow.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3EventHandler

Returns a new instance of GoogleCloudDialogflowCxV3EventHandler.



2154
2155
2156
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2154

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

Returns:

  • (String) 


2118
2119
2120
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2118

def event
  @event
end

#name ⇒ String

Output only. The unique identifier of this event handler. Corresponds to the JSON property name

Returns:

  • (String) 


2123
2124
2125
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2123

def name
  @name
end

#target_flow ⇒ String

The target flow to transition to. Format: projects//locations//agents//flows/ . Corresponds to the JSON property targetFlow

Returns:

  • (String) 


2129
2130
2131
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2129

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

Returns:

  • (String) 


2135
2136
2137
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2135

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

Returns:

  • (String) 


2141
2142
2143
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2141

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

Returns:



2152
2153
2154
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2152

def trigger_fulfillment
  @trigger_fulfillment
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2159
2160
2161
2162
2163
2164
2165
2166
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2159

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