Google Cloud Dialogflow V2 Client - Class ConversationEvent (1.7.2)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ConversationEvent.

Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.

Generated from protobuf message google.cloud.dialogflow.v2.ConversationEvent

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ conversation string

The unique identifier of the conversation this notification refers to. Format: projects/<Project ID>/conversations/<Conversation ID>.

↳ type int

The type of the event that this notification refers to.

↳ error_status Google\Rpc\Status

More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.

↳ new_message_payload Google\Cloud\Dialogflow\V2\Message

Payload of NEW_MESSAGE event.

getConversation

The unique identifier of the conversation this notification refers to.

Format: projects/<Project ID>/conversations/<Conversation ID>.

Returns
TypeDescription
string

setConversation

The unique identifier of the conversation this notification refers to.

Format: projects/<Project ID>/conversations/<Conversation ID>.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

The type of the event that this notification refers to.

Returns
TypeDescription
int

setType

The type of the event that this notification refers to.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getErrorStatus

More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.

Returns
TypeDescription
Google\Rpc\Status|null

hasErrorStatus

clearErrorStatus

setErrorStatus

More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getNewMessagePayload

Payload of NEW_MESSAGE event.

Returns
TypeDescription
Google\Cloud\Dialogflow\V2\Message|null

hasNewMessagePayload

setNewMessagePayload

Payload of NEW_MESSAGE event.

Parameter
NameDescription
var Google\Cloud\Dialogflow\V2\Message
Returns
TypeDescription
$this

getPayload

Returns
TypeDescription
string