Class: Google::Cloud::Dialogflow::CX::V3::EventHandler

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/page.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 Attribute Details

#event ⇒ ::String

Returns Required. The name of the event to handle.

Returns:

  • (::String) —

    Required. The name of the event to handle.



269
270
271
272
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 269

class EventHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String (readonly)

Returns Output only. The unique identifier of this event handler.

Returns:

  • (::String) —

    Output only. The unique identifier of this event handler.



269
270
271
272
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 269

class EventHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#target_flow ⇒ ::String

Returns The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

Note: The following fields are mutually exclusive: target_flow, target_page. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

    Note: The following fields are mutually exclusive: target_flow, target_page. If a field in that set is populated, all other fields in the set will automatically be cleared.



269
270
271
272
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 269

class EventHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#target_page ⇒ ::String

Returns The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

Note: The following fields are mutually exclusive: target_page, target_flow. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

    Note: The following fields are mutually exclusive: target_page, target_flow. If a field in that set is populated, all other fields in the set will automatically be cleared.



269
270
271
272
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 269

class EventHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#trigger_fulfillment ⇒ ::Google::Cloud::Dialogflow::CX::V3::Fulfillment

Returns The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.

Returns:

  • (::Google::Cloud::Dialogflow::CX::V3::Fulfillment) —

    The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.



269
270
271
272
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 269

class EventHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end