Package com.zendesk.sunshine_conversations_client.model

Class AppSettings

  • public class AppSettings
extends java.lang.Object
    Customizable app settings.

    • Field Detail

      • JSON_PROPERTY_CONVERSATION_RETENTION_SECONDS

        public static final java.lang.String JSON_PROPERTY_CONVERSATION_RETENTION_SECONDS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_MASK_CREDIT_CARD_NUMBERS

        public static final java.lang.String JSON_PROPERTY_MASK_CREDIT_CARD_NUMBERS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_USE_ANIMAL_NAMES

        public static final java.lang.String JSON_PROPERTY_USE_ANIMAL_NAMES
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ECHO_POSTBACK

        public static final java.lang.String JSON_PROPERTY_ECHO_POSTBACK
        See Also:
        Constant Field Values

      • JSON_PROPERTY_IGNORE_AUTO_CONVERSATION_START

        public static final java.lang.String JSON_PROPERTY_IGNORE_AUTO_CONVERSATION_START
        See Also:
        Constant Field Values

      • JSON_PROPERTY_MULTI_CONVO_ENABLED

        public static final java.lang.String JSON_PROPERTY_MULTI_CONVO_ENABLED
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ATTACHMENTS_ACCESS

        public static final java.lang.String JSON_PROPERTY_ATTACHMENTS_ACCESS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ATTACHMENTS_TOKEN_EXPIRATION_SECONDS

        public static final java.lang.String JSON_PROPERTY_ATTACHMENTS_TOKEN_EXPIRATION_SECONDS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_APP_LOCALIZATION_ENABLED

        public static final java.lang.String JSON_PROPERTY_APP_LOCALIZATION_ENABLED
        See Also:
        Constant Field Values

    • Constructor Detail

      • AppSettings

        public AppSettings()

    • Method Detail

      • conversationRetentionSeconds

        public AppSettings conversationRetentionSeconds​(java.lang.Integer conversationRetentionSeconds)

      • getConversationRetentionSeconds

        @Nullable
public java.lang.Integer getConversationRetentionSeconds()
        Number of seconds of inactivity before a conversation’s messages will be automatically deleted. See [Conversation Retention Seconds](https://docs.smooch.io/guide/creating-and-managing-apps/#conversation-retention-seconds) for more information. minimum: 0
        Returns:
        conversationRetentionSeconds

      • setConversationRetentionSeconds

        public void setConversationRetentionSeconds​(java.lang.Integer conversationRetentionSeconds)

      • maskCreditCardNumbers

        public AppSettings maskCreditCardNumbers​(java.lang.Boolean maskCreditCardNumbers)

      • getMaskCreditCardNumbers

        @Nullable
public java.lang.Boolean getMaskCreditCardNumbers()
        A boolean specifying whether credit card numbers should be masked when sent through Sunshine Conversations.
        Returns:
        maskCreditCardNumbers

      • setMaskCreditCardNumbers

        public void setMaskCreditCardNumbers​(java.lang.Boolean maskCreditCardNumbers)

      • useAnimalNames

        public AppSettings useAnimalNames​(java.lang.Boolean useAnimalNames)

      • getUseAnimalNames

        @Nullable
public java.lang.Boolean getUseAnimalNames()
        A boolean specifying whether animal names should be used for unnamed users. See the [user naming guide](https://docs.smooch.io/guide/receiving-messages/#message-author-name) for details.
        Returns:
        useAnimalNames

      • setUseAnimalNames

        public void setUseAnimalNames​(java.lang.Boolean useAnimalNames)

      • echoPostback

        public AppSettings echoPostback​(java.lang.Boolean echoPostback)

      • getEchoPostback

        @Nullable
public java.lang.Boolean getEchoPostback()
        A boolean specifying whether a message should be added to the conversation history when a postback button is clicked. See [Echo Postbacks](https://docs.smooch.io/guide/creating-and-managing-apps/#echo-postbacks) for more information.
        Returns:
        echoPostback

      • setEchoPostback

        public void setEchoPostback​(java.lang.Boolean echoPostback)

      • ignoreAutoConversationStart

        public AppSettings ignoreAutoConversationStart​(java.lang.Boolean ignoreAutoConversationStart)

      • getIgnoreAutoConversationStart

        @Nullable
public java.lang.Boolean getIgnoreAutoConversationStart()
        A boolean specifying whether a non message event coming from a channel will trigger a [start conversation](https://docs.smooch.io/rest/#section/Webhook-Triggers) event and count as a monthly active user (MAU). <aside class=\"notice\">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>
        Returns:
        ignoreAutoConversationStart

      • setIgnoreAutoConversationStart

        public void setIgnoreAutoConversationStart​(java.lang.Boolean ignoreAutoConversationStart)

      • multiConvoEnabled

        public AppSettings multiConvoEnabled​(java.lang.Boolean multiConvoEnabled)

      • getMultiConvoEnabled

        @Nullable
public java.lang.Boolean getMultiConvoEnabled()
        A boolean specifying whether users are allowed to be part of several conversations. Enabling `multiConvo` is **irreversible**.
        Returns:
        multiConvoEnabled

      • setMultiConvoEnabled

        public void setMultiConvoEnabled​(java.lang.Boolean multiConvoEnabled)

      • attachmentsAccess

        public AppSettings attachmentsAccess​(java.lang.String attachmentsAccess)

      • getAttachmentsAccess

        @Nullable
public java.lang.String getAttachmentsAccess()
        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=\"https://docs.smooch.io/guide/private-attachments/\">Private Attachments</a> for more information.
        Returns:
        attachmentsAccess

      • setAttachmentsAccess

        public void setAttachmentsAccess​(java.lang.String attachmentsAccess)

      • attachmentsTokenExpirationSeconds

        public AppSettings attachmentsTokenExpirationSeconds​(java.lang.Integer attachmentsTokenExpirationSeconds)

      • getAttachmentsTokenExpirationSeconds

        @Nullable
public java.lang.Integer getAttachmentsTokenExpirationSeconds()
        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=\"https://docs.smooch.io/guide/private-attachments/\">Private Attachments</a> for more information.
        Returns:
        attachmentsTokenExpirationSeconds

      • setAttachmentsTokenExpirationSeconds

        public void setAttachmentsTokenExpirationSeconds​(java.lang.Integer attachmentsTokenExpirationSeconds)

      • appLocalizationEnabled

        public AppSettings appLocalizationEnabled​(java.lang.Boolean appLocalizationEnabled)

      • getAppLocalizationEnabled

        @Nullable
public java.lang.Boolean getAppLocalizationEnabled()
        A boolean specifying whether the messages authored by the Sunshine Conversations platform should be localized.
        Returns:
        appLocalizationEnabled

      • setAppLocalizationEnabled

        public void setAppLocalizationEnabled​(java.lang.Boolean appLocalizationEnabled)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object