public class RuntimeResponseGeneric
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Classes which extend this class: - RuntimeResponseGenericRuntimeResponseTypeText - RuntimeResponseGenericRuntimeResponseTypePause - RuntimeResponseGenericRuntimeResponseTypeImage - RuntimeResponseGenericRuntimeResponseTypeOption - RuntimeResponseGenericRuntimeResponseTypeConnectToAgent - RuntimeResponseGenericRuntimeResponseTypeSuggestion - RuntimeResponseGenericRuntimeResponseTypeChannelTransfer - RuntimeResponseGenericRuntimeResponseTypeUserDefined - RuntimeResponseGenericRuntimeResponseTypeVideo - RuntimeResponseGenericRuntimeResponseTypeAudio - RuntimeResponseGenericRuntimeResponseTypeIframe
Modifier and Type | Class and Description |
---|---|
static interface |
RuntimeResponseGeneric.Preference
The preferred type of control to display.
|
Modifier and Type | Method and Description |
---|---|
AgentAvailabilityMessage |
agentAvailable()
Gets the agentAvailable.
|
AgentAvailabilityMessage |
agentUnavailable()
Gets the agentUnavailable.
|
String |
altText()
Gets the altText.
|
Map<String,Object> |
channelOptions()
Gets the channelOptions.
|
List<ResponseGenericChannel> |
channels()
Gets the channels.
|
String |
description()
Gets the description.
|
String |
dialogNode()
Gets the dialogNode.
|
String |
imageUrl()
Gets the imageUrl.
|
String |
messageToHumanAgent()
Gets the messageToHumanAgent.
|
String |
messageToUser()
Gets the messageToUser.
|
List<DialogNodeOutputOptionsElement> |
options()
Gets the options.
|
String |
preference()
Gets the preference.
|
String |
responseType()
Gets the responseType.
|
String |
source()
Gets the source.
|
List<DialogSuggestion> |
suggestions()
Gets the suggestions.
|
String |
text()
Gets the text.
|
Long |
time()
Gets the time.
|
String |
title()
Gets the title.
|
String |
topic()
Gets the topic.
|
Boolean |
typing()
Gets the typing.
|
Map<String,Object> |
userDefined()
Gets the userDefined.
|
public String responseType()
The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
public String text()
The text of the response.
public List<ResponseGenericChannel> channels()
An array of objects specifying channels for which the response is intended. If **channels** is present, the response is intended for a built-in integration and should not be handled by an API client.
public Long time()
How long to pause, in milliseconds.
public Boolean typing()
Whether to send a "user is typing" event during the pause.
public String source()
The `https:` URL of the image.
public String title()
The title or introductory text to show before the response.
public String description()
The description to show with the response.
public String altText()
Descriptive text that can be used for screen readers or other situations where the image cannot be seen.
public String preference()
The preferred type of control to display.
public List<DialogNodeOutputOptionsElement> options()
An array of objects describing the options from which the user can choose.
public String messageToHumanAgent()
A message to be sent to the human agent who will be taking over the conversation.
public AgentAvailabilityMessage agentAvailable()
An optional message to be displayed to the user to indicate that the conversation will be transferred to the next available agent.
public AgentAvailabilityMessage agentUnavailable()
An optional message to be displayed to the user to indicate that no online agent is available to take over the conversation.
public String topic()
A label identifying the topic of the conversation, derived from the **title** property of the relevant node or the **topic** property of the dialog node response.
public String dialogNode()
The unique ID of the dialog node that the **topic** property is taken from. The **topic** property is populated using the value of the dialog node's **title** property.
public List<DialogSuggestion> suggestions()
An array of objects describing the possible matching dialog nodes from which the user can choose.
public String messageToUser()
The message to display to the user when initiating a channel transfer.
public Map<String,Object> userDefined()
An object containing any properties for the user-defined response type.
public Map<String,Object> channelOptions()
For internal use only.
public String imageUrl()
The URL of an image that shows a preview of the embedded content.
Copyright © 2023 IBM Cloud. All rights reserved.