SunshineConversationsClient::CarouselMessage

August 27, 2025 ยท View on GitHub

Properties

NameTypeDescriptionNotes
typeStringThe type of message.[default to 'carousel']
textStringThe fallback text message used when carousel messages are not supported by the channel.[optional][readonly]
block_chat_inputBooleanWhen set to true, the chat input will be disabled on supported client implementations when the message is the most recent one in the history. Can be used for guided flows or to temporarily disable the user's ability to send messages in the conversation.[optional]
itemsArray<Item>An array of objects representing the items associated with the message. Only present in carousel and list type messages.
display_settingsCarouselMessageDisplaySettings[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::CarouselMessage.new(
  type: null,
  text: null,
  block_chat_input: null,
  items: null,
  display_settings: null
)