Google Cloud Ces V1 Client - Class GenerateChatTokenRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class GenerateChatTokenRequest.

Request message for WidgetService.GenerateChatToken.

Generated from protobuf message google.cloud.ces.v1.GenerateChatTokenRequest

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
`↳ deployment`	`string` Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
`↳ recaptcha_token`	`string` Optional. The reCAPTCHA token generated by the client-side chat widget.
`↳ live_handoff_enabled`	`bool` Optional. Indicates if live handoff is enabled for the session.

getName

Required. The session name to generate the chat token for.

Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Returns
Type	Description
`string`

setName

Required. The session name to generate the chat token for.

Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDeployment

Required. The deployment of the app to use for the session.

Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

Returns
Type	Description
`string`

setDeployment

Required. The deployment of the app to use for the session.

Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRecaptchaToken

Optional. The reCAPTCHA token generated by the client-side chat widget.

Returns
Type	Description
`string`

setRecaptchaToken