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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ conversation |
string
The unique identifier of the conversation this notification refers to. Format: |
↳ 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>.
Generated from protobuf field string conversation = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setConversation
The unique identifier of the conversation this notification refers to.
Format: projects/<Project ID>/conversations/<Conversation ID>.
Generated from protobuf field string conversation = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
The type of the event that this notification refers to.
Generated from protobuf field .google.cloud.dialogflow.v2.ConversationEvent.Type type = 2;
| Returns | |
|---|---|
| Type | Description |
int | |
setType
The type of the event that this notification refers to.
Generated from protobuf field .google.cloud.dialogflow.v2.ConversationEvent.Type type = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getErrorStatus
More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.
Generated from protobuf field .google.rpc.Status error_status = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasErrorStatus
clearErrorStatus
setErrorStatus
More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.
Generated from protobuf field .google.rpc.Status error_status = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNewMessagePayload
Payload of NEW_MESSAGE event.
Generated from protobuf field .google.cloud.dialogflow.v2.Message new_message_payload = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\Message|null | |
hasNewMessagePayload
setNewMessagePayload
Payload of NEW_MESSAGE event.
Generated from protobuf field .google.cloud.dialogflow.v2.Message new_message_payload = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\Message
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPayload
| Returns | |
|---|---|
| Type | Description |
string | |