public sealed class ParameterInfo : IMessage<PageInfo.Types.FormInfo.Types.ParameterInfo>, IEquatable<PageInfo.Types.FormInfo.Types.ParameterInfo>, IDeepCloneable<PageInfo.Types.FormInfo.Types.ParameterInfo>, IBufferMessage, IMessage
Reference documentation and code samples for the Dialogflow v3 API class PageInfo.Types.FormInfo.Types.ParameterInfo.
Represents parameter information.
Implements
IMessage<PageInfo.Types.FormInfo.Types.ParameterInfo>, IEquatable<PageInfo.Types.FormInfo.Types.ParameterInfo>, IDeepCloneable<PageInfo.Types.FormInfo.Types.ParameterInfo>, IBufferMessage, IMessageNamespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
ParameterInfo()
public ParameterInfo()
ParameterInfo(PageInfo.Types.FormInfo.Types.ParameterInfo)
public ParameterInfo(PageInfo.Types.FormInfo.Types.ParameterInfo other)
Parameter | |
---|---|
Name | Description |
other | PageInfo.Types.FormInfo.Types.ParameterInfo |
Properties
DisplayName
public string DisplayName { get; set; }
Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Required for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.
Property Value | |
---|---|
Type | Description |
String |
JustCollected
public bool JustCollected { get; set; }
Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. Indicates if the parameter value was just collected on the last conversation turn.
Property Value | |
---|---|
Type | Description |
Boolean |
Required
public bool Required { get; set; }
Optional for both [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest] and [WebhookResponse][google.cloud.dialogflow.cx.v3.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.
Property Value | |
---|---|
Type | Description |
Boolean |
State
public PageInfo.Types.FormInfo.Types.ParameterInfo.Types.ParameterState State { get; set; }
Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Required for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The state of the parameter. This field can be set to [INVALID][google.cloud.dialogflow.cx.v3.PageInfo.FormInfo.ParameterInfo.ParameterState.INVALID] by the webhook to invalidate the parameter; other values set by the webhook will be ignored.
Property Value | |
---|---|
Type | Description |
PageInfo.Types.FormInfo.Types.ParameterInfo.Types.ParameterState |
Value
public Value Value { get; set; }
Optional for both [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest] and [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The value of the parameter. This field can be set by the webhook to change the parameter value.
Property Value | |
---|---|
Type | Description |
Value |