Google Cloud Dialogflow Cx V3 Client - Class PageInfo (0.5.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
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: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

↳ display_name string

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

↳ form_info 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

Returns
Type Description
string

setCurrentPage

Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

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
PageInfo\FormInfo|null

hasFormInfo

clearFormInfo

setFormInfo

Optional for both WebhookRequest and WebhookResponse.

Information about the form.

Parameter
Name Description
var PageInfo\FormInfo
Returns
Type Description
$this