Class RuntimeResponseGeneric

All Implemented Interfaces:
Direct Known Subclasses:
RuntimeResponseGenericRuntimeResponseTypeChannelTransfer, RuntimeResponseGenericRuntimeResponseTypeConnectToAgent, RuntimeResponseGenericRuntimeResponseTypeImage, RuntimeResponseGenericRuntimeResponseTypeOption, RuntimeResponseGenericRuntimeResponseTypePause, RuntimeResponseGenericRuntimeResponseTypeSearch, RuntimeResponseGenericRuntimeResponseTypeSuggestion, RuntimeResponseGenericRuntimeResponseTypeText, RuntimeResponseGenericRuntimeResponseTypeUserDefined

public class RuntimeResponseGeneric

Classes which extend this class: - RuntimeResponseGenericRuntimeResponseTypeText - RuntimeResponseGenericRuntimeResponseTypePause - RuntimeResponseGenericRuntimeResponseTypeImage - RuntimeResponseGenericRuntimeResponseTypeOption - RuntimeResponseGenericRuntimeResponseTypeConnectToAgent - RuntimeResponseGenericRuntimeResponseTypeSuggestion - RuntimeResponseGenericRuntimeResponseTypeChannelTransfer - RuntimeResponseGenericRuntimeResponseTypeSearch - RuntimeResponseGenericRuntimeResponseTypeUserDefined

  • Method Details

    • responseType

      public String responseType()
      Gets the responseType.

      The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.

      the responseType
    • text

      public String text()
      Gets the text.

      The text of the response.

      the text
    • channels

      public List<ResponseGenericChannel> channels()
      Gets the 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.

      the channels
    • time

      public Long time()
      Gets the time.

      How long to pause, in milliseconds.

      the time
    • typing

      public Boolean typing()
      Gets the typing.

      Whether to send a "user is typing" event during the pause.

      the typing
    • source

      public String source()
      Gets the source.

      The `https:` URL of the image.

      the source
    • title

      public String title()
      Gets the title.

      The title to show before the response.

      the title
    • description

      public String description()
      Gets the description.

      The description to show with the the response.

      the description
    • altText

      public String altText()
      Gets the altText.

      Descriptive text that can be used for screen readers or other situations where the image cannot be seen.

      the altText
    • preference

      public String preference()
      Gets the preference.

      The preferred type of control to display.

      the preference
    • options

      Gets the options.

      An array of objects describing the options from which the user can choose.

      the options
    • messageToHumanAgent

      public String messageToHumanAgent()
      Gets the messageToHumanAgent.

      A message to be sent to the human agent who will be taking over the conversation.

      the messageToHumanAgent
    • agentAvailable

      public AgentAvailabilityMessage agentAvailable()
      Gets the agentAvailable.

      An optional message to be displayed to the user to indicate that the conversation will be transferred to the next available agent.

      the agentAvailable
    • agentUnavailable

      public AgentAvailabilityMessage agentUnavailable()
      Gets the agentUnavailable.

      An optional message to be displayed to the user to indicate that no online agent is available to take over the conversation.

      the agentUnavailable
    • topic

      public String topic()
      Gets the 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.

      the topic
    • suggestions

      public List<DialogSuggestion> suggestions()
      Gets the suggestions.

      An array of objects describing the possible matching dialog nodes from which the user can choose.

      the suggestions
    • messageToUser

      public String messageToUser()
      Gets the messageToUser.

      The message to display to the user when initiating a channel transfer.

      the messageToUser
    • header

      public String header()
      Gets the header.

      The title or introductory text to show before the response. This text is defined in the search skill configuration.

      the header
    • primaryResults

      public List<SearchResult> primaryResults()
      Gets the primaryResults.

      An array of objects that contains the search results to be displayed in the initial response to the user.

      the primaryResults
    • additionalResults

      public List<SearchResult> additionalResults()
      Gets the additionalResults.

      An array of objects that contains additional search results that can be displayed to the user upon request.

      the additionalResults
    • userDefined

      public Map<String,​Object> userDefined()
      Gets the userDefined.

      An object containing any properties for the user-defined response type.

      the userDefined