Skip to content

AppSettings.md

Latest commit

 

History

History
33 lines (26 loc) · 3.37 KB

AppSettings.md

File metadata and controls

33 lines (26 loc) · 3.37 KB

SunshineConversationsClient::AppSettings

Properties

Name Type Description Notes
conversation_retention_seconds Integer Number of seconds of inactivity before a conversation’s messages will be automatically deleted. See Conversation Retention Seconds for more information. [optional]
mask_credit_card_numbers Boolean A boolean specifying whether credit card numbers should be masked when sent through Sunshine Conversations. [optional]
use_animal_names Boolean A boolean specifying whether animal names should be used for unnamed users. See the user naming guide for details. [optional]
echo_postback Boolean A boolean specifying whether a message should be added to the conversation history when a postback button is clicked. See Echo Postbacks for more information. [optional]
ignore_auto_conversation_start Boolean A boolean specifying whether a non message event coming from a channel will trigger a start conversation event and count as a monthly active user (MAU). <aside class=&quot;notice&quot;>Calling <code>startConversation()</code> (or equivalent) from the Android, iOS or Web SDK will count as a MAU, regardless of the value of this setting.</aside> [optional]
multi_convo_enabled Boolean A boolean specifying whether users are allowed to be part of several conversations. Enabling `multiConvo` is irreversible. [optional]
attachments_access String A string specifying whether attachments should be stored in a publicly or privately accessible cloud storage. attachmentsAccess is set to public by default but can be modified to private. See <a href=&quot;https://docs.smooch.io/guide/private-attachments/\&quot;&gt;Private Attachments</a> for more information. [optional]
attachments_token_expiration_seconds Integer Number of seconds representing the expiration time of the generated media tokens for private attachments. The JWT will be valid for 2 hours by default. See See <a href=&quot;https://docs.smooch.io/guide/private-attachments/\&quot;&gt;Private Attachments</a> for more information. [optional]
app_localization_enabled Boolean A boolean specifying whether the messages authored by the Sunshine Conversations platform should be localized. [optional]

Code Sample

require 'SunshineConversationsClient'

instance = SunshineConversationsClient::AppSettings.new(conversation_retention_seconds: null,
                                 mask_credit_card_numbers: null,
                                 use_animal_names: null,
                                 echo_postback: null,
                                 ignore_auto_conversation_start: null,
                                 multi_convo_enabled: null,
                                 attachments_access: public,
                                 attachments_token_expiration_seconds: 64028,
                                 app_localization_enabled: null)