Google Cloud Dialogflow Cx V3 Client - Class PageInfo (0.1.1)

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 \ V3

Methods

__construct

Constructor.

Parameters
NameDescription
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: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

↳ 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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Always present for WebhookRequest. Ignored for WebhookResponse. The display name of the current page.

Returns
TypeDescription
string

setDisplayName

Always present for WebhookRequest. Ignored for WebhookResponse. The display name of the current page.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFormInfo

Optional for both WebhookRequest and WebhookResponse.

Information about the form.

Returns
TypeDescription
Google\Cloud\Dialogflow\Cx\V3\PageInfo\FormInfo|null

hasFormInfo

clearFormInfo

setFormInfo

Optional for both WebhookRequest and WebhookResponse.

Information about the form.

Parameter
NameDescription
var Google\Cloud\Dialogflow\Cx\V3\PageInfo\FormInfo
Returns
TypeDescription
$this