Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.61 KB

FileMessage.md

File metadata and controls

29 lines (22 loc) · 1.61 KB

SunshineConversationsClient::FileMessage

Properties

Name Type Description Notes
type String The type of message. [default to 'file']
media_url String The URL for media, such as an image, attached to the message. <aside class=&quot;notice&quot;>Note that for private attachments an authorization header is required to access the mediaUrl. See <a href=&quot;https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/\&quot;&gt;Configuring private attachments for messaging</a> guide for more details.</aside>
media_size Float The size of the media. [optional] [readonly]
media_type String The media type of the file. [optional] [readonly]
alt_text String An optional description of the file 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]
attachment_id String An identifier used by Sunshine Conversations for internal purposes. [optional]

Code Sample

require 'SunshineConversationsClient'

instance = SunshineConversationsClient::FileMessage.new(type: null,
                                 media_url: null,
                                 media_size: null,
                                 media_type: null,
                                 alt_text: null,
                                 text: null,
                                 attachment_id: null)