Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::WebhookResponse (v0.24.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::WebhookResponse.

The response message for a webhook call.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#fulfillment_response

def fulfillment_response() -> ::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse

Returns

(::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse) — The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

#fulfillment_response=

def fulfillment_response=(value) -> ::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse) — The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

Returns

(::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse) — The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

#page_info

def page_info() -> ::Google::Cloud::Dialogflow::CX::V3::PageInfo

Returns

(::Google::Cloud::Dialogflow::CX::V3::PageInfo) — Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

#page_info=

def page_info=(value) -> ::Google::Cloud::Dialogflow::CX::V3::PageInfo

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::PageInfo) — Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

Returns

(::Google::Cloud::Dialogflow::CX::V3::PageInfo) — Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

#payload

def payload() -> ::Google::Protobuf::Struct

Returns

(::Google::Protobuf::Struct) — Value to append directly to QueryResult.webhook_payloads.

#payload=

def payload=(value) -> ::Google::Protobuf::Struct

Parameter

value (::Google::Protobuf::Struct) — Value to append directly to QueryResult.webhook_payloads.

Returns

(::Google::Protobuf::Struct) — Value to append directly to QueryResult.webhook_payloads.

#session_info

def session_info() -> ::Google::Cloud::Dialogflow::CX::V3::SessionInfo

Returns

(::Google::Cloud::Dialogflow::CX::V3::SessionInfo) — Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

#session_info=

def session_info=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SessionInfo

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::SessionInfo) — Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

Returns

(::Google::Cloud::Dialogflow::CX::V3::SessionInfo) — Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

#target_flow

def target_flow() -> ::String

Returns

(::String) — The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

#target_flow=

def target_flow=(value) -> ::String

Parameter

value (::String) — The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Returns

(::String) — The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

#target_page

def target_page() -> ::String

Returns

(::String) — The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

#target_page=

def target_page=(value) -> ::String

Parameter

value (::String) — The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Returns

(::String) — The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.