Package zendesk.support

Class SupportSdkSettings


  • public class SupportSdkSettings
extends java.lang.Object
    Wraps SupportSettings and makes settings call null-safe.

    This class will generally default to false or 0 for return values if they don't exist.

    Created by Zendesk on 28/07/15.

    • Constructor Detail

      • SupportSdkSettings

        public SupportSdkSettings(zendesk.support.SupportSettings supportSettings,
                          HelpCenterSettings helpCenterSettings,
                          AuthenticationType authenticationType)
        Creates an instance of SafeMobileSettings
        Parameters:
        supportSettings - The Support SDK settings
        helpCenterSettings - The Help Center SDK settings
        authenticationType - The authentication type

    • Method Detail

      • isConversationsEnabled

        public boolean isConversationsEnabled()
        Checks if conversations are enabled or not
        Returns:
        true only if conversations are enabled, false if they are not or the settings are missing

      • isAttachmentsEnabled

        public boolean isAttachmentsEnabled()
        Checks if attachments are enabled or not
        Returns:
        true only if they are enabled, false if they are not or the settings are missing

      • getMaxAttachmentSize

        public long getMaxAttachmentSize()
        Gets the maximum attachment size allowed in bytes
        Returns:
        The maximum attachment size allowed in bytes, or 0 if the settings are missing

      • hasHelpCenterSettings

        public boolean hasHelpCenterSettings()
        Checks if we have Help Center settings or not.
        Returns:
        true if we have a non-null HelpCenterSettings, false if not.

      • isHelpCenterEnabled

        public boolean isHelpCenterEnabled()
        Checks if help center is enabled or not.
        Returns:
        true only if help center is enabled, false if it is not or if the settings are missing

      • isHelpCenterArticleVotingEnabled

        public boolean isHelpCenterArticleVotingEnabled()
        Checks if help center voting is enabled or not.
        Returns:
        true only if help center voting is enabled, false if it is not or if the settings are missing

      • getHelpCenterLocale

        public java.lang.String getHelpCenterLocale()
        Gets the default locale of the help center
        Returns:
        the default locale of the help center, or the empty string if the settings are missing

      • getContactZendeskTags

        public java.util.List<java.lang.String> getContactZendeskTags()
        Gets the tags to use for the ContactZendesk components.

      • getAuthenticationType

        public AuthenticationType getAuthenticationType()

      • isTicketFormSupportAvailable

        public boolean isTicketFormSupportAvailable()
        Gets if TicketForm support is available, or not.
        Returns:
        true if TicketForm support is available, false if not.

      • isNeverAskForEmailEnabled

        public boolean isNeverAskForEmailEnabled()
        Checks if the SDK is allowed to ask the end-user for an email address if needed
        Returns:
        true if the SDK is not allowed to ask for an email address.

      • isShowClosedRequests

        public boolean isShowClosedRequests()
        Checks if the SDK is allowed to show closed requests in the RequestListView.
        Returns:
        true if the SDK should should display closed requests.

      • isShowReferrerLogoEnabled

        public boolean isShowReferrerLogoEnabled()
        Checks if the SDK is allowed to display a referrer logo inside the RequestListView and RequestViewConversationsDisabled.
        Returns:
        true if the SDK should display a referrer logo.

      • getReferrerUrl

        public java.lang.String getReferrerUrl()
        Gets the url that will be opened when referrer logo is clicked.
        Returns:
        the referrer url if we have it, empty String otherwise.

      • getRequestSystemMessage

        public java.lang.String getRequestSystemMessage()
        Gets the system message that will be shown after the first message was successfully sent.
        Returns:
        the system message as a string