SunshineConversationsClient::FormMessage

August 27, 2025 ยท View on GitHub

Properties

NameTypeDescriptionNotes
typeStringThe type of message.[default to 'form']
submittedBooleanFlag which states whether the form is submitted.[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]
fieldsArray<FormMessageField>An array of objects representing fields associated with the message. Only present in form and formResponse messages.

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::FormMessage.new(
  type: null,
  submitted: null,
  block_chat_input: null,
  fields: null
)