Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class PageInfo.
Represents page information communicated to and from the webhook.
Generated from protobuf message google.cloud.dialogflow.cx.v3.PageInfo
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ current_page |
string
Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: |
↳ display_name |
string
Always present for WebhookRequest. Ignored for WebhookResponse. The display name of the current page. |
↳ form_info |
Google\Cloud\Dialogflow\Cx\V3\PageInfo\FormInfo
Optional for both WebhookRequest and WebhookResponse. Information about the form. |
getCurrentPage
Always present for
WebhookRequest. Ignored for
WebhookResponse. The
unique identifier of the current page. Format: projects/<Project
ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page
ID>.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCurrentPage
Always present for
WebhookRequest. Ignored for
WebhookResponse. The
unique identifier of the current page. 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 |
|
getDisplayName
Always present for WebhookRequest. Ignored for WebhookResponse. The display name of the current page.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Always present for WebhookRequest. Ignored for WebhookResponse. The display name of the current page.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFormInfo
Optional for both WebhookRequest and WebhookResponse.
Information about the form.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\Cx\V3\PageInfo\FormInfo|null |
|
hasFormInfo
clearFormInfo
setFormInfo
Optional for both WebhookRequest and WebhookResponse.
Information about the form.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\Cx\V3\PageInfo\FormInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|