Google Cloud Dialogflow Cx V3 Client - Class WebhookResponse (0.1.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class WebhookResponse.

The response message for a webhook call.

Generated from protobuf message google.cloud.dialogflow.cx.v3.WebhookResponse

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ fulfillment_response`	`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`	`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.
`↳ session_info`	`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.
`↳ payload`	`Google\Protobuf\Struct` Value to append directly to QueryResult.webhook_payloads.
`↳ target_page`	`string` The target page to transition to. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>`.
`↳ target_flow`	`string` The target flow to transition to. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>`.

getFulfillmentResponse

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
Type	Description
`Google\Cloud\Dialogflow\Cx\V3\WebhookResponse\FulfillmentResponse\|null`

hasFulfillmentResponse

clearFulfillmentResponse

setFulfillmentResponse

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.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\Cx\V3\WebhookResponse\FulfillmentResponse`

Returns
Type	Description
`$this`

getPageInfo

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

Returns
Type	Description
`Google\Cloud\Dialogflow\Cx\V3\PageInfo\|null`

hasPageInfo

clearPageInfo

setPageInfo

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\Cx\V3\PageInfo`

Returns
Type	Description
`$this`

getSessionInfo

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

Returns
Type	Description
`Google\Cloud\Dialogflow\Cx\V3\SessionInfo\|null`

hasSessionInfo

clearSessionInfo

setSessionInfo

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\Cx\V3\SessionInfo`

Returns
Type	Description
`$this`

getPayload

Value to append directly to QueryResult.webhook_payloads.

Returns
Type	Description
`Google\Protobuf\Struct\|null`

hasPayload

clearPayload

setPayload

Value to append directly to QueryResult.webhook_payloads.

Parameter
Name	Description
`var`	`Google\Protobuf\Struct`

Returns
Type	Description
`$this`

getTargetPage

The target page to transition to.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Returns
Type	Description
`string`

hasTargetPage

setTargetPage

The target page to transition to.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTargetFlow

The target flow to transition to.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Returns
Type	Description
`string`

hasTargetFlow

setTargetFlow

The target flow to transition to.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTransition

Returns
Type	Description
`string`