Google Cloud Dialogflow V2 Client - Class Message (1.4.0)

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

Represents a message posted into a conversation.

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

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Optional. The unique identifier of the message. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID> .

↳ content
string

Required. The message content.

↳ language_code
string

Optional. The message language. This should be a BCP-47 language tag. Example: "en-US".

↳ participant
string

Output only. The participant that sends this message.

↳ participant_role
int

Output only. The role of the participant.

↳ create_time
Google\Protobuf\Timestamp

Output only. The time when the message was created in Contact Center AI.

↳ send_time
Google\Protobuf\Timestamp

Optional. The time when the message was sent.

↳ message_annotation
Google\Cloud\Dialogflow\V2\MessageAnnotation

Output only. The annotation for the message.

↳ sentiment_analysis
Google\Cloud\Dialogflow\V2\SentimentAnalysisResult

Output only. The sentiment analysis result for the message.

getName

Optional. The unique identifier of the message.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID> .

Returns
Type
Description
string

setName

Optional. The unique identifier of the message.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID> .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getContent

Required. The message content.

Returns
Type
Description
string

setContent

Required. The message content.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLanguageCode

Optional. The message language.

This should be a BCP-47 language tag. Example: "en-US".

Returns
Type
Description
string

setLanguageCode

Optional. The message language.

This should be a BCP-47 language tag. Example: "en-US".

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getParticipant

Output only. The participant that sends this message.

Returns
Type
Description
string

setParticipant

Output only. The participant that sends this message.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getParticipantRole

Output only. The role of the participant.

Returns
Type
Description
int

setParticipantRole

Output only. The role of the participant.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getCreateTime

Output only. The time when the message was created in Contact Center AI.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the message was created in Contact Center AI.

Parameter
Name
Description
Returns
Type
Description
$this

getSendTime

Optional. The time when the message was sent.

Returns
Type
Description

hasSendTime

clearSendTime

setSendTime

Optional. The time when the message was sent.

Parameter
Name
Description
Returns
Type
Description
$this

getMessageAnnotation

Output only. The annotation for the message.

Returns
Type
Description

hasMessageAnnotation

clearMessageAnnotation

setMessageAnnotation

Output only. The annotation for the message.

Parameter
Name
Description
Returns
Type
Description
$this

getSentimentAnalysis

Output only. The sentiment analysis result for the message.

hasSentimentAnalysis

clearSentimentAnalysis

setSentimentAnalysis

Output only. The sentiment analysis result for the message.

Returns
Type
Description
$this