Represents a ResponseMessage.
Package
@google-cloud/dialogflow-cxConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dialogflow.cx.v3.IResponseMessage);Constructs a new ResponseMessage.
| Parameter | |
|---|---|
| Name | Description |
properties |
IResponseMessage
Properties to set |
Properties
channel
public channel: string;ResponseMessage channel.
conversationSuccess
public conversationSuccess?: (google.cloud.dialogflow.cx.v3.ResponseMessage.IConversationSuccess|null);ResponseMessage conversationSuccess.
endInteraction
public endInteraction?: (google.cloud.dialogflow.cx.v3.ResponseMessage.IEndInteraction|null);ResponseMessage endInteraction.
knowledgeInfoCard
public knowledgeInfoCard?: (google.cloud.dialogflow.cx.v3.ResponseMessage.IKnowledgeInfoCard|null);ResponseMessage knowledgeInfoCard.
liveAgentHandoff
public liveAgentHandoff?: (google.cloud.dialogflow.cx.v3.ResponseMessage.ILiveAgentHandoff|null);ResponseMessage liveAgentHandoff.
message
public message?: ("text"|"payload"|"conversationSuccess"|"outputAudioText"|"liveAgentHandoff"|"endInteraction"|"playAudio"|"mixedAudio"|"telephonyTransferCall"|"knowledgeInfoCard");ResponseMessage message.
mixedAudio
public mixedAudio?: (google.cloud.dialogflow.cx.v3.ResponseMessage.IMixedAudio|null);ResponseMessage mixedAudio.
outputAudioText
public outputAudioText?: (google.cloud.dialogflow.cx.v3.ResponseMessage.IOutputAudioText|null);ResponseMessage outputAudioText.
payload
public payload?: (google.protobuf.IStruct|null);ResponseMessage payload.
playAudio
public playAudio?: (google.cloud.dialogflow.cx.v3.ResponseMessage.IPlayAudio|null);ResponseMessage playAudio.
responseType
public responseType: (google.cloud.dialogflow.cx.v3.ResponseMessage.ResponseType|keyof typeof google.cloud.dialogflow.cx.v3.ResponseMessage.ResponseType);ResponseMessage responseType.
telephonyTransferCall
public telephonyTransferCall?: (google.cloud.dialogflow.cx.v3.ResponseMessage.ITelephonyTransferCall|null);ResponseMessage telephonyTransferCall.
text
public text?: (google.cloud.dialogflow.cx.v3.ResponseMessage.IText|null);ResponseMessage text.
Methods
create(properties)
public static create(properties?: google.cloud.dialogflow.cx.v3.IResponseMessage): google.cloud.dialogflow.cx.v3.ResponseMessage;Creates a new ResponseMessage instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IResponseMessage
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ResponseMessage | ResponseMessage instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3.ResponseMessage;Decodes a ResponseMessage message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
ResponseMessage | ResponseMessage |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3.ResponseMessage;Decodes a ResponseMessage message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ResponseMessage | ResponseMessage |
encode(message, writer)
public static encode(message: google.cloud.dialogflow.cx.v3.IResponseMessage, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ResponseMessage message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IResponseMessage
ResponseMessage message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.dialogflow.cx.v3.IResponseMessage, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ResponseMessage message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IResponseMessage
ResponseMessage message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.dialogflow.cx.v3.ResponseMessage;Creates a ResponseMessage message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
ResponseMessage | ResponseMessage |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ResponseMessage
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this ResponseMessage to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dialogflow.cx.v3.ResponseMessage, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ResponseMessage message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ResponseMessage
ResponseMessage |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a ResponseMessage message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|