Skip to content

ImageMessage.md

Latest commit

 

History

History
38 lines (32 loc) · 3.08 KB

ImageMessage.md

File metadata and controls

38 lines (32 loc) · 3.08 KB

SunshineConversationsClient::ImageMessage

Properties

Name Type Description Notes
type String The type of message. [default to 'image']
media_url String The URL for media, such as an image, attached to the message. <aside class=&quot;notice&quot;><strong>Note:</strong> An authorization header is required to access the mediaUrl when private attachments are enabled. See configuring private attachments for messaging guide for more details.</aside>
media_type String The type of media. [optional][readonly]
media_size Float The size of the media in bytes. [optional][readonly]
alt_text String An optional description of the image for accessibility purposes. The field will be saved by default with the file name as the value. [optional]
text String The text content of the message. [optional]
block_chat_input Boolean When 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]
html_text String HTML text content of the message. Can be provided in place of `text`. Cannot be used with `markdownText`. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See rich text documentation for more information. [optional]
markdown_text String Markdown text content of the message. Can be provided in place of `text`. Cannot be used with `htmlText`. Will be converted to `htmlText` upon reception. If converted `htmlText` exceeds 4096 characters, the message will be rejected. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See rich text documentation for more information. [optional]
actions Array<Action> Array of message actions. [optional]
attachment_id String An identifier used by Sunshine Conversations for internal purposes. [optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::ImageMessage.new(
  type: null,
  media_url: null,
  media_type: null,
  media_size: null,
  alt_text: null,
  text: null,
  block_chat_input: null,
  html_text: &lt;h1&gt;Hello!&lt;/h1&gt;,
  markdown_text: # Hello!,
  actions: null,
  attachment_id: null
)