Package zendesk.support

Enum Support

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Support>

    public enum Support
extends java.lang.Enum<Support>
    Configuration class for Zendesk initialization. Call this first to configure Zendesk to use the correct credentials and Zendesk URL.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      INSTANCE 

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Locale getHelpCenterLocaleOverride()
      Returns the override, if any, for the locale to be used in Help Center requests.
      void init(Zendesk zendesk)
      Initialises the Zendesk SDK
      boolean isInitialized()
      Gets whether Support.init(Zendesk) was called or not.
      ProviderStore provider()
      Gets a ProviderStore for accessing all available SDK Providers.
      boolean refreshRequest(java.lang.String requestId, Context context)
      Refreshes the Support SDK RequestActivity if it is currently being displayed (after Activity#onResume() but before Activity#onPause()) for the given request ID, or the RequestListActivity if it has not been destroyed (ie, by Activity#onDestroy().
      void setHelpCenterLocaleOverride(java.util.Locale locale)
      Set a locale override for Help Center content.
      static Support valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Support[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • INSTANCE

        public static final Support INSTANCE

    • Method Detail

      • values

        public static Support[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Support c : Support.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Support valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • init

        public void init(Zendesk zendesk)
        Initialises the Zendesk SDK

        Use this constructor when you have enabled the Conversations feature. This requires some authentication settings. Your zendeskUrl must be your full Zendesk URL in the form of https://{subdomain.zendesk.com You should replace {subdomain} with your own subdomain.

        A lazy loading strategy is applied to all Provider calls to ensure that settings are always present before a call to Zendesk.

        Parameters:
        zendesk - The instance of zendesk to initialize Support with

      • isInitialized

        public boolean isInitialized()
        Gets whether Support.init(Zendesk) was called or not.
        Returns:
        true if init was successfully called, false otherwise.

      • refreshRequest

        public boolean refreshRequest(java.lang.String requestId,
                              Context context)
        Refreshes the Support SDK RequestActivity if it is currently being displayed (after Activity#onResume() but before Activity#onPause()) for the given request ID, or the RequestListActivity if it has not been destroyed (ie, by Activity#onDestroy(). This is intended for use in the handling of push notifications for updates on Zendesk Support requests. If not using push notifications, or using a provider-only integration (ie, not using the Support SDK UI), then this method should not be used. The method should be called from the android.content.BroadcastReceiver being used to receive your push notifications. If the Support SDK UI is currently on screen, this method will trigger a refresh to capture the update, and return true. If it is not on screen, this method will return false. We recommend showing a notification to the user only if this method returns false.
        Parameters:
        requestId - the ID of the request to refresh
        context - the application Context
        Returns:
        true if the conversation UI was refreshed on screen, false if not.

      • setHelpCenterLocaleOverride

        public void setHelpCenterLocaleOverride(java.util.Locale locale)
        Set a locale override for Help Center content. By default, Help Center content will be requested in the locale of the device. Use this method to force a specific locale to be used when requesting Help Center content.

        Note that if you set a locale that is not supported on your Help Center, you will not receive any content.

        Parameters:
        locale - the locale to force in all requests to Help Center.

      • getHelpCenterLocaleOverride

        public java.util.Locale getHelpCenterLocaleOverride()
        Returns the override, if any, for the locale to be used in Help Center requests. If no override has been set, the device locale will be used.
        Returns:
        the locale override, or null if no override has been set.