Google Cloud Dialogflow Cx V3 Client - Class ParameterInfo (0.3.4)

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

Represents parameter information.

Generated from protobuf message google.cloud.dialogflow.cx.v3.PageInfo.FormInfo.ParameterInfo

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3 \ PageInfo \ FormInfo

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ display_name string

Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.

↳ required bool

Optional for both WebhookRequest and WebhookResponse. Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

↳ state int

Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.

↳ value Google\Protobuf\Value

Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.

↳ just_collected bool

Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.

getDisplayName

Always present for WebhookRequest.

Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.

Returns
Type Description
string

setDisplayName

Always present for WebhookRequest.

Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequired

Optional for both WebhookRequest and WebhookResponse.

Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

Returns
Type Description
bool

setRequired

Optional for both WebhookRequest and WebhookResponse.

Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

Parameter
Name Description
var bool
Returns
Type Description
$this

getState

Always present for WebhookRequest.

Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.

Returns
Type Description
int

setState

Always present for WebhookRequest.

Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.

Parameter
Name Description
var int
Returns
Type Description
$this

getValue

Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.

Returns
Type Description
Google\Protobuf\Value|null

hasValue

clearValue

setValue

Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.

Parameter
Name Description
var Google\Protobuf\Value
Returns
Type Description
$this

getJustCollected

Optional for WebhookRequest. Ignored for WebhookResponse.

Indicates if the parameter value was just collected on the last conversation turn.

Returns
Type Description
bool

setJustCollected

Optional for WebhookRequest. Ignored for WebhookResponse.

Indicates if the parameter value was just collected on the last conversation turn.

Parameter
Name Description
var bool
Returns
Type Description
$this