Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo (v1.3.0)

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

Represents parameter information.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#display_name

def display_name() -> ::String
Returns
  • (::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.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#just_collected

def just_collected() -> ::Boolean
Returns
  • (::Boolean) — Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.

#just_collected=

def just_collected=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.
Returns
  • (::Boolean) — Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.

#required

def required() -> ::Boolean
Returns
  • (::Boolean) — 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.

#required=

def required=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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

def state() -> ::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState
Returns

#state=

def state=(value) -> ::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState
Parameter
Returns

#value

def value() -> ::Google::Protobuf::Value
Returns

#value=

def value=(value) -> ::Google::Protobuf::Value
Parameter
Returns