Google Cloud Dialogflow Cx V3 Client - Class TransitionRoute (0.5.0)

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

A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order:

  • If there is a trigger_fulfillment associated with the transition, it will be called.

  • If there is a target_page associated with the transition, the session will transition into the specified page.

  • If there is a target_flow associated with the transition, the session will transition into the specified flow.

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

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. The unique identifier of this transition route.
↳ description string

Optional. The description of the transition route. The maximum length is 500 characters.
↳ intent string

The unique identifier of an Intent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.
↳ condition string

The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.
↳ trigger_fulfillment Fulfillment

The fulfillment to call when the condition is satisfied. At least one of trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
↳ target_page string

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

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

getName

Output only. The unique identifier of this transition route.

Returns
Type Description
string

setName

Output only. The unique identifier of this transition route.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. The description of the transition route. The maximum length is 500 characters.

Returns
Type Description
string

setDescription

Optional. The description of the transition route. The maximum length is 500 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getIntent

The unique identifier of an Intent.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.

Returns
Type Description
string

setIntent

The unique identifier of an Intent.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.

Parameter
Name Description
var string
Returns
Type Description
$this

getCondition

The condition to evaluate against form parameters or session parameters.

See the conditions reference. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.

Returns
Type Description
string

setCondition

The condition to evaluate against form parameters or session parameters.

See the conditions reference. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.

Parameter
Name Description
var string
Returns
Type Description
$this

getTriggerFulfillment

The fulfillment to call when the condition is satisfied. At least one of trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.

Returns
Type Description
Fulfillment|null

hasTriggerFulfillment

clearTriggerFulfillment

setTriggerFulfillment

The fulfillment to call when the condition is satisfied. At least one of trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.

Parameter
Name Description
var Fulfillment
Returns
Type Description
$this

getTargetPage

The target page to transition to.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

Returns
Type Description
string

hasTargetPage

setTargetPage

The target page to transition to.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getTargetFlow

The target flow to transition to.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

Returns
Type Description
string

hasTargetFlow

setTargetFlow

The target flow to transition to.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getTarget

Returns
Type Description
string