Class HelpCenterSettings

  • All Implemented Interfaces:
    Settings


    public class HelpCenterSettings
    extends java.lang.Object
    implements Settings
    Models the Help Center settings which will be used by the SupportActivity. These settings are populated by downloading your applications' settings.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getLocale()
      Gets the locale that we should request Help Center content in by default.
      boolean isArticleVotingEnabled()
      Determines whether the Help Center voting feature is enabled or not.
      boolean isEnabled()
      Determines whether the Help Center feature is enabled or not.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • isEnabled

        public boolean isEnabled()
        Determines whether the Help Center feature is enabled or not.
        Returns:
        true if help center is enabled, false otherwise.
      • getLocale

        public java.lang.String getLocale()
        Gets the locale that we should request Help Center content in by default.

        This locale will be the "best" fit as determined by Zendesk based on the locale that was supplied during the call to get your applications' settings. This is the device locale by default, but can be overridden by calling Guide.setHelpCenterLocaleOverride(Locale)

        Returns:
        The default locale that should be used when requesting Help Center content
      • isArticleVotingEnabled

        public boolean isArticleVotingEnabled()
        Determines whether the Help Center voting feature is enabled or not.
        Returns:
        true if help center voting is enabled, false otherwise.